Enum hcl::Error

source · [−]

#[non_exhaustive]
pub enum Error {
    Message {
        msg: String,
        location: Option<Location>,
    },
    Eof,
    Utf8(Utf8Error),
    Io(Error),
    InvalidEscape(char),
    InvalidUnicodeCodePoint(String),
}

Expand description

The error type used by this crate.

Variants (Non-exhaustive)

This enum is marked as 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.

`Message`

Fields

msg: String

The error message.

location: Option<Location>

An optional location context where the error happened in the input.

Represents a generic error message with optional location.

`Eof`

Represents the error emitted when the Deserializer hits an unexpected end of input.

`Utf8(Utf8Error)`

Represents an error that resulted from invalid UTF8 input.

`Io(Error)`

Represents generic IO errors.

`InvalidEscape(char)`

Represents errors due to invalid escape characters that may occur when unescaping user-provided strings.

`InvalidUnicodeCodePoint(String)`

Represents errors due to invalid unicode code points that may occur when unescaping user-provided strings.

Implementations

source

impl Error

source

pub fn location(&self) -> Option<&Location>

Returns the Location in the input where the error happened, if available.

Trait Implementations

source

impl Debug for Error

source

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

Formats the value using the given formatter. Read more

source

impl Display for Error

source

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

Formats the value using the given formatter. Read more

source

impl Error for Error

1.30.0 · source

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

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

source

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred. Read more

1.0.0 · source

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

source

impl Error for Error

source

fn custom<T: Display>(msg: T) -> Self

Used when a Serialize implementation encounters any error while serializing a type. Read more

source

impl Error for Error

source

fn custom<T: Display>(msg: T) -> Self

Raised when there is general error when deserializing a type. Read more

source

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting. Read more

source

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason. Read more

source

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements. Read more

source

fn unknown_variant(variant: &str, expected: &'static [&'static str ]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name. Read more

source

fn unknown_field(field: &str, expected: &'static [&'static str ]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name. Read more

source

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input. Read more

source