Enum virtue::Error

pub enum Error {
    UnknownDataType(Span),
    InvalidRustSyntax {
        span: Span,
        expected: String,
    },
    ExpectedIdent(Span),
    PushParse {
        span: Option<Span>,
        error: PushParseError,
    },
    Custom {
        error: String,
        span: Option<Span>,
    },
}

Errors that can occur while parsing or generator your derive macro.

Variants

UnknownDataType(Span)

The data type at Span is unknown. This will be called when Parse::new is called on anything that is not a struct or enum.

InvalidRustSyntax

The rust syntax is invalid. This can be returned while parsing the Enum or Struct.

This error is assumed to not appear as rustc will do syntax checking before virtue gets access to the TokenStream. However this error could still be returned.

Fields

span: Span

The span at which the invalid syntax is found

expected: String

The expected rust syntax when this parsing occured

ExpectedIdent(Span)

Expected an ident at the given span.

PushParse

Failed to parse the code passed to StreamBuilder::push_parsed.

Fields

span: Option<Span>

An optional span. Normally this is None, unless .with_span is called.

error: PushParseError

The internal parse error

Custom

A custom error thrown by the developer

Fields

error: String

The error message

span: Option<Span>

Optionally the position that the error occurred at

Implementations

impl Error

pub fn custom(s: impl Into<String>) -> Self

Throw a custom error

pub fn custom_at(s: impl Into<String>, span: Span) -> Self

Throw a custom error at a given location

pub fn custom_at_token(s: impl Into<String>, token: TokenTree) -> Self

Throw a custom error at a given token

pub fn custom_at_opt_token( s: impl Into<String>, token: Option<TokenTree> ) -> Self

Throw a custom error at a given Option<TokenTree>

pub fn with_span(self, new_span: Span) -> Self

Return a new error that is located at the given span

impl Error

pub fn into_token_stream(self) -> TokenStream

Turn this error into a TokenStream so it shows up as a compile_error for the user.

pub fn throw_with_span(self, span: Span) -> TokenStream

Turn this error into a TokenStream so it shows up as a compile_error for the user. The error will be shown at the given span.

Trait Implementations

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, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<PushParseError> for Error

fn from(e: PushParseError) -> Self

Converts to this type from the input type.