Struct FilePackPath

pub struct FilePackPath {
    pub file: File,
    pub pack_path: PackPath,
}

File (describing the content) + its PackPath (describing uri that the file will be accessible at).

This is the main item added to the pack.

It can be manually created by passing file and pack_path fields or using associated helpers methods.

Fields

file: File

The file.

pack_path: PackPath

The path inside the pack, corresponding to http path parameter.

Implementations

impl FilePackPath

pub fn build_from_path( path: &Path, base_directory_path: &Path, file_options: &BuildFromPathOptions, ) -> Result<Self, Error>

Creates self by reading file relative to given base directory.

Given file path (path) to read and base directory path creates a self by preparing:

• File with file::build_from_path using file::BuildFromPathOptions.
• PackPath with pack_path::from_file_base_relative_path (as relative path between path and base_directory_path).

Examples

// base directory
let base_directory = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
    .parent()
    .ok_or_else(|| anyhow!("missing parent"))?
    .join("tests")
    .join("data")
    .join("vcard-personal-portfolio");

// file in base/directory/path/index.html should end up as /index.html
let file_pack_path_1 = FilePackPath::build_from_path(
    &base_directory.join("index.html"),
    &base_directory,
    &BuildFromPathOptions::default(),
)?;
assert_eq!(
    file_pack_path_1.file.content_type,
    "text/html; charset=utf-8"
);
assert_eq!(&*file_pack_path_1.pack_path, "/index.html");

// file in base/directory/path/website-demo-image/desktop.png should end up as /website-demo-image/desktop.png
let file_pack_path_2 = FilePackPath::build_from_path(
    &base_directory.join("website-demo-image").join("desktop.png"),
    &base_directory,
    &BuildFromPathOptions::default(),
)?;
assert_eq!(
    file_pack_path_2.file.content_type,
    "image/png"
);
assert_eq!(&*file_pack_path_2.pack_path, "/website-demo-image/desktop.png");

Trait Implementations

impl Debug for FilePackPath

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.