Enum StructureMode

pub enum StructureMode {
    Flat,
    FlatGrouped,
    Nested,
    NestedGrouped,
}

An enum representing the ways to structure a template’s rendered files.

Variants

Flat

When selected, the template is rendered to the output directory without any structure.

output-mode: flat

[ouput-directory]
 │
 ├─ [template-name-01].[extension]
 ├─ [template-name-01].[extension]
 └─ ...

FlatGrouped

When selected, the template is rendered to the output directory and placed inside a directory named after its group. This useful if there are multiple related and unrelated templates being rendered to the same directory.

output-mode: flat-grouped

[ouput-directory]
 │
 ├─ [template-group-01]
 │   ├─ [template-name-01].[extension]
 │   ├─ [template-name-01].[extension]
 │   └─ ...
 │
 ├─ [template-group-02]
 │   └─ ...
 └─ ...

Nested

When selected, the template is rendered to the output directory and placed inside a directory named after its nested-directory-template. This useful if multiple templates are used to represent a single book i.e. a book template used to render a book’s information to a single file and an annotation template used to render each annotation to a separate file.

output-mode: nested

[ouput-directory]
 │
 ├─ [author-title-01]
 │   ├─ [template-name-01].[extension]
 │   ├─ [template-name-01].[extension]
 │   └─ ...
 │
 ├─ [author-title-02]
 │   └─ ...
 └─ ...

NestedGrouped

When selected, the template is rendered to the output directory and placed inside a directory named after its group and another named after its nested-directory-template. This useful if multiple templates are used to represent a single book i.e. a book template and an annotation template and there are multiple related and unrelated templates being rendered to the same directory.

output-mode: nested-grouped

[ouput-directory]
 │
 ├─ [template-group-01]
 │   │
 │   ├─ [author-title-01]
 │   │   ├─ [template-name-01].[extension]
 │   │   ├─ [template-name-01].[extension]
 │   │   └─ ...
 │   │
 │   ├─ [author-title-02]
 │   │   ├─ [template-name-02].[extension]
 │   │   ├─ [template-name-02].[extension]
 │   │   └─ ...
 │   └─ ...
 │
 ├─ [template-group-02]
 │   ├─ [author-title-01]
 │   │   └─ ...
 │   └─ ...
 └─ ...

Trait Implementations

impl Clone for StructureMode

fn clone(&self) -> StructureMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructureMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructureMode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Copy for StructureMode