Enum TemplateError 

#[non_exhaustive]
pub enum TemplateError {
    NotFound {
        name: String,
        referenced_from: Option<String>,
        searched: Vec<String>,
    },
    Unreadable {
        name: String,
        message: String,
    },
    SearchPath {
        directory: String,
        message: String,
    },
    Malformed {
        file: String,
        key: Option<String>,
        message: String,
    },
    ChainConflict {
        variable: String,
        field: ChainField,
        nearer: String,
        nearer_value: &'static str,
        farther: String,
        farther_value: &'static str,
    },
    MalformedAnswers {
        message: String,
    },
    UnknownAnswer {
        names: Vec<String>,
    },
    MistypedAnswer {
        name: String,
        kind: VariableType,
        expected: String,
        problem: String,
    },
    MissingRequired {
        names: Vec<String>,
    },
    Render {
        file: Option<String>,
        line: Option<usize>,
        name: Option<String>,
        message: String,
    },
    MalformedLoader {
        message: String,
    },
    LoaderDigest {
        stated: String,
        computed: String,
    },
}

Why a template could not be loaded, answered or rendered.

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.

NotFound

A name or path the chain needs resolved to nothing.

Fields

name: String

The name or path.

referenced_from: Option<String>

The chain file that named it, when one did.

searched: Vec<String>

The search path directories it was looked for in.

Unreadable

A template that is there and could not be read — a permission, or a directory where a file was named.

Fields

name: String

The path it was read at.

message: String

Why the read failed.

SearchPath

A search path directory that is missing or is not a directory, refused before any template is looked for, so a mistyped one is not silently searched as empty.

Fields

directory: String

The directory as it was given.

message: String

Why it cannot be searched.

Malformed

A chain file that is not a template this format reads.

Fields

file: String

The chain file.

key: Option<String>

The front matter key the refusal is about, when it is about one.

message: String

What is wrong.

ChainConflict

Two chain files declaring one variable with different types or items.

Fields

variable: String

The variable.

field: ChainField

Which field differs.

nearer: String

The file nearer the rendered template.

nearer_value: &'static str

What that file declares.

farther: String

The file farther from it.

farther_value: &'static str

What that file declares.

MalformedAnswers

An answers document that is not a mapping of answers.

Fields

message: String

What is wrong with it.

UnknownAnswer

Answers naming no declared variable.

Fields

names: Vec<String>

Every undeclared name answered, in name order.

MistypedAnswer

An answer that is not a value of its variable’s type.

Fields

name: String

The variable.

kind: VariableType

Its type.

expected: String

Its type with an article, for the message.

problem: String

Why the answer is not one.

MissingRequired

Required variables no answer and no default covers.

Fields

names: Vec<String>

Every one, in declaration order.

Render

The render itself failed: an undefined name, or an error a filter or tag raised.

Fields

file: Option<String>

The chain file the render failed in.

line: Option<usize>

The file’s own line, front matter counted.

name: Option<String>

The undefined name, when that is what failed.

message: String

What failed.

MalformedLoader

A template loader document that is not one this product reads.

Fields

message: String

What is wrong with it.

LoaderDigest

A loader document stating a digest its chain does not compute.

Fields

stated: String

The digest the document states.

computed: String

The digest its chain computes.

Implementations

impl TemplateError

pub fn kind(&self) -> &'static str

This product’s kebab-case name for the failure.

pub fn refuses_answers(&self) -> bool

Whether this refuses the answers rather than the template: an answers document that is not one, an answer to no declared variable or of the wrong type, and required variables left unanswered. The command line exits 2 for these.

Trait Implementations

impl Clone for TemplateError

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateError

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

Formats the value using the given formatter.

impl Display for TemplateError

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

Formats the value using the given formatter.

impl Error for TemplateError

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

Returns 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 PartialEq for TemplateError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TemplateError