Struct bloguen::ops::BlogueDescriptorIndex

pub struct BlogueDescriptorIndex {
    pub header_file: (String, PathBuf),
    pub center_file: (String, PathBuf),
    pub footer_file: (String, PathBuf),
    pub center_order: CenterOrder,
    pub styles: Vec<StyleElement>,
    pub scripts: Vec<ScriptElement>,
    pub data: BTreeMap<String, String>,
}

Metadata pertaining specifically to generating an index file.

Fields

header_file: (String, PathBuf)

Data to put start index HTML with, templated.

Default: "$ROOT/index_header.html", then "$ROOT/index_header.htm", then "$ROOT/idx_header.html", then "$ROOT/idx_header.htm".

center_file: (String, PathBuf)

Data to put in index HTML for each post, templated.

Default: "$ROOT/index_center.html", then "$ROOT/index_center.htm", then "$ROOT/idx_center.html", then "$ROOT/idx_center.htm".

footer_file: (String, PathBuf)

Data to put to end index HTML with, templated.

Default: "$ROOT/index_footer.html", then "$ROOT/index_footer.htm", then "$ROOT/idx_footer.html", then "$ROOT/idx_footer.htm".

center_order: CenterOrder

The order to put center templates in.

If not present, defaults to forward.

styles: Vec<StyleElement>

A set of style descriptors.

If not present, defaults to empty.

scripts: Vec<ScriptElement>

A set of style descriptors.

If not present, defaults to empty.

data: BTreeMap<String, String>

Additional static data to substitute in header and footer.

If not present, defaults to empty.

Trait Implementations

impl Eq for BlogueDescriptorIndex

impl Clone for BlogueDescriptorIndex

fn clone(&self) -> BlogueDescriptorIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<BlogueDescriptorIndex> for BlogueDescriptorIndex

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

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

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

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

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

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

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

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

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

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

impl PartialEq<BlogueDescriptorIndex> for BlogueDescriptorIndex

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

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

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

This method tests for !=.

impl Ord for BlogueDescriptorIndex

fn cmp(&self, other: &BlogueDescriptorIndex) -> 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.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Hash for BlogueDescriptorIndex

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 Debug for BlogueDescriptorIndex

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

Formats the value using the given formatter.