Struct NamesRender

pub struct NamesRender {
    pub book: String,
    pub annotations: HashMap<String, AnnotationNameAttributes>,
    pub directory: String,
}

A struct representing the rendered template strings for all the output file and directory names for a given template.

This is used to (1) name files and directories when rendering templates to disk and (2) is included in the template’s context so that files/direcories related to the template can be references within the tenplate.

See Renderer::render() for more information.

Fields

book: String

The output filename for a template with ContextMode::Book.

annotations: HashMap<String, AnnotationNameAttributes>

The output filenames for a template with ContextMode::Annotation.

Internally this field is stored as a HashMap but is converted into a Vec before it’s injected into a template.

directory: String

The directory name for a template with StructureMode::Nested or StructureMode::NestedGrouped.

Implementations

impl NamesRender

pub fn new(entry: &EntryContext<'_>, template: &Template) -> Result<Self>

Creates a new instance of NamesRender.

Note that all names are generated regardless of the template’s ContextMode. For example, when a separate template is used to render a Book and another for its Annotations, it’s important that both templates have access to the other’s filenames so they can link to one another if the user desires.

Arguments

• entry - The context injected into the filename templates.
• template - The template containing the filename templates.

Errors

Will return Err if any templates have syntax errors or are referencing non-existent fields in their respective contexts.

pub fn get_annotation_filename(&self, annotation_id: &str) -> String

Returns the rendered annotation filename based on its id.

Arguments

• annotation_id - The annotation’s id.

Trait Implementations

impl Clone for NamesRender

fn clone(&self) -> NamesRender

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NamesRender

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

Formats the value using the given formatter.

impl Default for NamesRender

fn default() -> NamesRender

Returns the “default value” for a type.

impl Serialize for NamesRender

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.