Enum tpnote_lib::template::TemplateKind

#[non_exhaustive]
pub enum TemplateKind {
    New,
    FromClipboardYaml,
    FromClipboard,
    FromTextFile,
    AnnotateFile,
    SyncFilename,
    None,
}

Each workflow is related to one TemplateKind, which relates to one content template and one filename template.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

New

Templates used when Tp-Note is invoked with a directory path.

FromClipboardYaml

Templates used when the clipboard contains a text with a YAML header.

FromClipboard

Templates used when the clipboard contains a text without header.

FromTextFile

Templates used when Tp-Note is invoked with a path pointing to a text file that does not contain a YAML header.

AnnotateFile

Templates used when Tp-Note is invoked with a path pointing to a non text file.

SyncFilename

Templates used when Tp-Note is invoked with a path pointing to a Tp-Note text file with a valid YAML header (containing as title: field).

None

No templates are used, but the file is still parsed in order to render it later to HTML (c.f. <Note>.render_content_to_html() and <Note>.export_html()).

Implementations

impl TemplateKind

pub fn from<T: Content>(
    path: &Path,
    clipboard: &T,
    stdin: &T
) -> (Self, Option<T>)

Constructor encoding the logic under what circumstances what template. should be used.

Contract: If template_kind is one of:

• TemplateKind::New
• TemplateKind::FromClipboardYaml
• TemplateKind::FromClipboard
• TemplateKind::AnnotateFile content is None because it is not used. Otherwise, the file’s content from the is read from the disk and returned as Some(..).

pub fn get_content_template(&self) -> String

Returns the content template string as it is defined in the configuration file.

pub fn get_content_template_name(&self) -> &str

Returns the content template variable name as it is used in the configuration file.

pub fn get_filename_template(&self) -> String

Returns the file template string as it is defined in the configuration file.

pub fn get_filename_template_name(&self) -> &str

Returns the content template variable name as it is used in the configuration file.

Trait Implementations

impl Clone for TemplateKind

fn clone(&self) -> TemplateKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateKind

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

Formats the value using the given formatter.

impl Default for TemplateKind

fn default() -> TemplateKind

Returns the “default value” for a type.

impl PartialEq<TemplateKind> for TemplateKind

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TemplateKind

impl Eq for TemplateKind

impl StructuralEq for TemplateKind

impl StructuralPartialEq for TemplateKind