Enum subst::error::Error

pub enum Error {
    InvalidEscapeSequence(InvalidEscapeSequence),
    MissingVariableName(MissingVariableName),
    UnexpectedCharacter(UnexpectedCharacter),
    MissingClosingBrace(MissingClosingBrace),
    NoSuchVariable(NoSuchVariable),
}

An error that can occur during variable substitution.

Variants

InvalidEscapeSequence(InvalidEscapeSequence)

The input string contains an invalid escape sequence.

MissingVariableName(MissingVariableName)

The input string contains a variable placeholder without a variable name ("${}").

UnexpectedCharacter(UnexpectedCharacter)

The input string contains an unexpected character.

MissingClosingBrace(MissingClosingBrace)

The input string contains an unclosed variable placeholder.

NoSuchVariable(NoSuchVariable)

The input string contains a placeholder for a variable that is not in the variable map.

Implementations

impl Error

pub fn source_range(&self) -> Range<usize>

Get the range in the source text that contains the error.

pub fn source_line<'a>(&self, source: &'a str) -> &'a str

Get the line of source that contains the error.

Panics

May panic if the source text is not the original source that contains the error.

pub fn write_source_highlighting( &self, f: &mut impl Write, source: &str ) -> Result

Write source highlighting for the error location.

The highlighting ends with a newline.

Note: this function doesn’t print anything if the source line exceeds 60 characters in width. For more control over this behaviour, consider using Self::source_range() and Self::source_line() instead.

pub fn source_highlighting(&self, source: &str) -> String

Get source highlighting for the error location as a string.

The highlighting ends with a newline.

Note: this function returns an empty string if the source line exceeds 60 characters in width.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(other: Error) -> Self

Converts to this type from the input type.

impl From<InvalidEscapeSequence> for Error

fn from(other: InvalidEscapeSequence) -> Self

Converts to this type from the input type.

impl From<MissingClosingBrace> for Error

fn from(other: MissingClosingBrace) -> Self

Converts to this type from the input type.

impl From<MissingVariableName> for Error

fn from(other: MissingVariableName) -> Self

Converts to this type from the input type.

impl From<NoSuchVariable> for Error

fn from(other: NoSuchVariable) -> Self

Converts to this type from the input type.

impl From<UnexpectedCharacter> for Error

fn from(other: UnexpectedCharacter) -> Self

Converts to this type from the input type.