Struct iqps_backend::pathutils::Paths

pub struct Paths {
    static_files_url: Url,
    static_files_path: PathBuf,
    system_paths: PathTriad,
    path_slugs: PathTriad,
}

Struct containing all the paths and URLs required to parse or create any question paper’s slug, absolute path, or URL.

Fields

static_files_url: Url

URL of the static files server

static_files_path: PathBuf

The absolute path to the location from where the static files server serves files

system_paths: PathTriad

The absolute system paths to all three directories on the server

path_slugs: PathTriad

The slugs to all three directories

A slug is a relative path independent of the URL or system path. This slug is stored in the database and either the crate::pathutils::Paths::static_files_url or the crate::pathutils::Paths::static_files_path is prepended to it to get its URL (to send to the frontend) or the system path (for backend operations)

Implementations

impl Paths

pub fn new( static_files_url: &str, static_file_storage_location: &Path, uploaded_qps_relative_path: &Path, library_qps_relative_path: &Path, ) -> Result<Self, Error>

Creates a new Paths struct

Arguments

• static_files_url - The static files server URL (eg: https://static.metakgp.org)
• static_file_storage_location - The path to the location on the server from which the static files are served (eg: /srv/static)
• uploaded_qps_relative_path - The path to the uploaded question papers, relative to the static files storage location. (eg: /iqps/uploaded)
• library_qps_relative_path - The path to the library question papers, relative to the static files storage location. (eg: /peqp/qp)

pub fn get_slug(&self, filename: &str, category: PaperCategory) -> String

Returns the slug for a given filename and paper category (directory)

pub fn get_path(&self, filename: &str, dir: PaperCategory) -> PathBuf

Returns the absolute system path for the specified directory and filename

pub fn get_path_from_slug(&self, slug: &str) -> PathBuf

Returns the absolute system path from a given slug

pub fn get_url( &self, filename: &str, dir: PaperCategory, ) -> Result<String, Error>

Returns the static server URL for the specified directory and filename

pub fn get_url_from_slug(&self, slug: &str) -> Result<String, Error>

Returns the static server URL for a given slug

pub fn sanitize_path(path: &str) -> String

Removes any non-alphanumeric character and replaces whitespaces with - Also replaces / with - and multiple spaces or hyphens will be replaced with a single one

Trait Implementations

impl Clone for Paths

fn clone(&self) -> Paths

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Paths

fn default() -> Self

Returns the “default value” for a type.