Enum gen_epub_book::ops::IncludeDirectory

pub enum IncludeDirectory {
    Unnamed {
        dir: (String, PathBuf),
    },
    Named {
        name: String,
        dir: (String, PathBuf),
    },
}

Representation of an -Include directory.

Textually, unnamed -Include directories take the form of "path", and named -Include directories take the form of "name=path".

Variants

Unnamed

An unnamed include directory, acting transparently

Fields of Unnamed

dir: (String, PathBuf)

Directory path

Named

A named include directory, saved with prefixes.

Fields of Named

name: String

-Include directory name.

dir: (String, PathBuf)

Directory path.

Methods

impl IncludeDirectory

pub fn directory_name(&self) -> &str

Get the name of the include directory

(Also known as self.dir.0, but it's a convenience function, because :enums:.)

Examples

assert_eq!(
    IncludeDirectory::Unnamed {
        dir: ("cur-dir".to_string(), PathBuf::from(".")),
    }.directory_name(),
    "cur-dir");
assert_eq!(
    IncludeDirectory::Named {
        name: "dot".to_string(),
        dir: ("named-cur-dir".to_string(), PathBuf::from(".")),
    }.directory_name(),
    "named-cur-dir");

pub fn packed_name<P: AsRef<Path>>(&self, f: P) -> PathBuf

Get packed filename for file specified by path.

Basically optionally prefixes util::book_filename().

Path separator, if any, is always '/'.

Examples

let fname = Path::new("content/ch01.html");
assert_eq!(
    IncludeDirectory::Unnamed {
        dir: ("cur-dir".to_string(), PathBuf::from(".")),
    }.packed_name(&fname),
    book_filename(&fname));
assert_eq!(
    IncludeDirectory::Named {
        name: "dot".to_string(),
        dir: ("named-cur-dir".to_string(), PathBuf::from(".")),
    }.packed_name(&fname).display().to_string(),
    format!("dot/{}", book_filename(&fname).display()));

pub fn packed_id(&self, f: &Path) -> String

Get the (X)HTML ID from a path.

Basically optionally prefixes util::xhtml_path_id().

Examples

let fname = Path::new("content/ch01.html");
assert_eq!(
    IncludeDirectory::Unnamed {
        dir: ("cur-dir".to_string(), PathBuf::from(".")),
    }.packed_id(&fname),
    xhtml_path_id(&fname));
assert_eq!(
    IncludeDirectory::Named {
        name: "dot".to_string(),
        dir: ("named-cur-dir".to_string(), PathBuf::from(".")),
    }.packed_id(&fname),
    format!("dot--{}", xhtml_path_id(&fname)));

pub fn resolve<P: AsRef<Path>>(&self, relpath: P) -> Option<PathBuf>

Resolve the path of the specified file in this include directory, or None if nonexistant or isn't a file.

Examples

let default_dir = special_book.join("gep").join("special");
let previews_dir = special_book.join("previews").join("generated").join("out");
let rendered_dir = special_book.join("rendered").join("output");
let default = IncludeDirectory::Unnamed {
    dir: ("".to_string(), default_dir.clone()),
};
let previews = IncludeDirectory::Named {
    name: "previews".to_string(),
    dir: ("../../previews/generated/out".to_string(), previews_dir.clone()),
};
let rendered = IncludeDirectory::Unnamed {
    dir: ("../../rendered/output".to_string(), rendered_dir.clone()),
};

assert_eq!(default.resolve(Path::new("intro.html")), Some(default_dir.join("intro.html")));
assert_eq!(previews.resolve(Path::new("main.html")), Some(previews_dir.join("main.html")));
assert_eq!(rendered.resolve(Path::new("ending.html")),
           Some(rendered_dir.join("ending.html")));
assert_eq!(default.resolve(Path::new("cover.png")), None);
assert_eq!(default.resolve(Path::new("../special")), None);

Trait Implementations

impl PartialEq<IncludeDirectory> for IncludeDirectory

fn eq(&self, other: &IncludeDirectory) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IncludeDirectory) -> bool

This method tests for !=.

impl Ord for IncludeDirectory

fn cmp(&self, other: &IncludeDirectory) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Clone for IncludeDirectory

fn clone(&self) -> IncludeDirectory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for IncludeDirectory

impl PartialOrd<IncludeDirectory> for IncludeDirectory

fn partial_cmp(&self, other: &IncludeDirectory) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &IncludeDirectory) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &IncludeDirectory) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &IncludeDirectory) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &IncludeDirectory) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for IncludeDirectory

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

Formats the value using the given formatter.

impl Display for IncludeDirectory

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

Formats the value using the given formatter.

impl Hash for IncludeDirectory

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl FromStr for IncludeDirectory

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<IncludeDirectory, Error>

Parses a string s to return a value of this type.