Enum hcl::Error

source ·

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

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.

`InvalidIdentifier(String)`

Represents errors that resulted from identifiers that are not valid in HCL.

`Eval(Error)`

Represents errors during expression evaluation.

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

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

fn provide(&'a self, demand: &mut Demand<'a>)

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

Provides type based access to context intended for error reports. Read more

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

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

Raised when a Deserialize struct type received more than one of the same field. Read more

source

impl From<Error<Rule>> for Error

source

fn from(err: Error<Rule>) -> Self

Converts to this type from the input type.

source

impl From<Error> for Error

source

fn from(err: Error) -> Self

Converts to this type from the input type.

source

impl From<Error> for Error

source

fn from(err: Error) -> Self

Converts to this type from the input type.

source

impl From<Error> for Error

source

fn from(err: Error) -> Self

Converts to this type from the input type.

source

impl From<Utf8Error> for Error

source

fn from(err: Utf8Error) -> Self

Converts to this type from the input type.

source

impl<'de> IntoDeserializer<'de, Error> for Attribute

type Deserializer = MapAccessDeserializer<AttributeAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for BinaryOp

type Deserializer = MapAccessDeserializer<BinaryOpAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for BinaryOperator

type Deserializer = StrDeserializer<'static, Error>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Block

type Deserializer = MapAccessDeserializer<BlockAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for BlockLabel

type Deserializer = BlockLabel

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Body

type Deserializer = NewtypeStructDeserializer<Vec<Structure, Global>, Error>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Conditional

type Deserializer = MapAccessDeserializer<ConditionalAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Expression

type Deserializer = Expression

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for ForExpr

type Deserializer = MapAccessDeserializer<ForExprAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for FuncCall

type Deserializer = MapAccessDeserializer<FuncCallAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Heredoc

type Deserializer = MapAccessDeserializer<HeredocAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for HeredocStripMode

type Deserializer = StrDeserializer<'static, Error>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Identifier

type Deserializer = NewtypeStructDeserializer<String, Error>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for ObjectKey

type Deserializer = ObjectKey

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Operation

type Deserializer = Operation

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for RawExpression

type Deserializer = NewtypeStructDeserializer<String, Error>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Structure

type Deserializer = Structure

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for TemplateExpr

type Deserializer = TemplateExpr

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Traversal

type Deserializer = MapAccessDeserializer<TraversalAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for TraversalOperator

type Deserializer = TraversalOperator

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for UnaryOp

type Deserializer = MapAccessDeserializer<UnaryOpAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for UnaryOperator

type Deserializer = StrDeserializer<'static, Error>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Value

type Deserializer = ValueDeserializer

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl<'de> IntoDeserializer<'de, Error> for Variable

type Deserializer = NewtypeStructDeserializer<String, Error>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

Auto Trait Implementations

impl !RefUnwindSafe for Error

impl Send for Error

impl Sync for Error

impl Unpin for Error

impl !UnwindSafe for Error

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<E> Provider for Ewhere
E: Error + ?Sized,

source

fn provide(&'a self, demand: &mut Demand<'a>)

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

Data providers should implement this method to provide all values they are able to provide by using demand. Read more

source

impl<T> ToString for Twhere
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.