Enum tpnote_lib::error::NoteError

pub enum NoteError {
    CanNotExpandShorthandLink {
        path: String,
    },
    CannotPrependHeader {
        existing_header: String,
    },
    File(FileError),
    FrontMatterFieldIsInvalidSortTag {
        sort_tag: String,
        sort_tag_extra_chars: String,
        filename_sort_tag_letters_in_succession_max: u8,
    },
    FrontMatterFieldIsDuplicateSortTag {
        sort_tag: String,
        existing_file: String,
    },
    FrontMatterFieldIsCompound {
        field_name: String,
    },
    FrontMatterFieldIsEmptyString {
        field_name: String,
    },
    FrontMatterFieldIsNotBool {
        field_name: String,
    },
    FrontMatterFieldIsNotNumber {
        field_name: String,
    },
    FrontMatterFieldIsNotString {
        field_name: String,
    },
    FrontMatterFieldIsNotTpnoteExtension {
        extension: String,
        extensions: String,
    },
    FrontMatterFieldMissing {
        field_name: String,
    },
    FrontMatterMissing {
        compulsory_field: String,
    },
    InvalidFrontMatterYaml {
        front_matter: String,
        source_error: Error,
    },
    InvalidInputYaml {
        tmpl_var: String,
        source_str: String,
    },
    InvalidLocalPath {
        path: String,
    },
    Io(Error),
    ParseLanguageCode(LibCfgError),
    Read {
        path: PathBuf,
        source: Error,
    },
    RstParse {
        msg: String,
    },
    Tera {
        source: Error,
    },
    TeraTemplate {
        source_str: String,
        template_str: String,
    },
    Utf8Conversion {
        source: Utf8Error,
    },
}

Error type returned form methods in or related to the note module.

Variants

CanNotExpandShorthandLink

Fields

path: String

Remedy: make sure, that a file starting with path exists.

CannotPrependHeader

Fields

existing_header: String

Remedy: report this error. It should not happen.

File(FileError)

FrontMatterFieldIsInvalidSortTag

Fields

sort_tag: String

sort_tag_extra_chars: String

filename_sort_tag_letters_in_succession_max: u8

Remedy: remove invalid characters.

FrontMatterFieldIsDuplicateSortTag

Fields

sort_tag: String

existing_file: String

Remedy: choose another sort-tag.

FrontMatterFieldIsCompound

Fields

field_name: String

Remedy: index the compound type?

FrontMatterFieldIsEmptyString

Fields

field_name: String

Remedy: try to enclose with quotes.

FrontMatterFieldIsNotBool

Fields

field_name: String

Remedy: try to remove possible quotes.

FrontMatterFieldIsNotNumber

Fields

field_name: String

Remedy: try to remove possible quotes.

FrontMatterFieldIsNotString

Fields

field_name: String

Remedy: try to enclose with quotes.

FrontMatterFieldIsNotTpnoteExtension

Fields

extension: String

extensions: String

Remedy: correct the front matter variable file_ext.

FrontMatterFieldMissing

Fields

field_name: String

Remedy: add the missing field in the note’s front matter.

FrontMatterMissing

Fields

compulsory_field: String

Remedy: check front matter delimiters ----.

InvalidFrontMatterYaml

Fields

front_matter: String

source_error: Error

Remedy: check YAML syntax in the note’s front matter.

InvalidInputYaml

Fields

tmpl_var: String

source_str: String

Remedy: check YAML syntax in the input stream’s front matter.

InvalidLocalPath

Fields

path: String

Remedy: correct link path.

Io(Error)

ParseLanguageCode(LibCfgError)

Read

Fields

path: PathBuf

source: Error

Remedy: check the file permission of the note file.

RstParse

Fields

msg: String

Remedy: check reStructuredText syntax.

Tera

Fields

source: Error

Remedy: restart with --debug trace.

TeraTemplate

Fields

source_str: String

template_str: String

Remedy: check the syntax of the Tera template in the configuration file.

Utf8Conversion

Fields

source: Utf8Error

Trait Implementations

impl Debug for NoteError

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

Formats the value using the given formatter.

impl Display for NoteError

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

Formats the value using the given formatter.

impl Error for NoteError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

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

Provides type based access to context intended for error reports.

impl From<Error> for NoteError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for NoteError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<FileError> for NoteError

fn from(source: FileError) -> Self

Converts to this type from the input type.

impl From<LibCfgError> for NoteError

fn from(source: LibCfgError) -> Self

Converts to this type from the input type.

impl From<Utf8Error> for NoteError

fn from(source: Utf8Error) -> Self

Converts to this type from the input type.