[][src]Struct syn::Error

pub struct Error { /* fields omitted */ }

Error returned when a Syn parser cannot parse the input tokens.

Refer to the module documentation for details about parsing in Syn.

This type is available if Syn is built with the "parsing" feature.

Methods

impl Error[src]

pub fn new<T: Display>(span: Span, message: T) -> Self[src]

Usually the ParseStream::error method will be used instead, which automatically uses the correct span from the current position of the parse stream.

Use Error::new when the error needs to be triggered on some span other than where the parse stream is currently positioned.

Example

This code runs with edition 2018
use syn::{Error, Ident, LitStr, Result, Token};
use syn::parse::ParseStream;

// Parses input that looks like `name = "string"` where the key must be
// the identifier `name` and the value may be any string literal.
// Returns the string literal.
fn parse_name(input: ParseStream) -> Result<LitStr> {
    let name_token: Ident = input.parse()?;
    if name_token != "name" {
        // Trigger an error not on the current position of the stream,
        // but on the position of the unexpected identifier.
        return Err(Error::new(name_token.span(), "expected `name`"));
    }
    input.parse::<Token![=]>()?;
    let s: LitStr = input.parse()?;
    Ok(s)
}

pub fn new_spanned<T: ToTokens, U: Display>(tokens: T, message: U) -> Self[src]

Creates an error with the specified message spanning the given syntax tree node.

Unlike the Error::new constructor, this constructor takes an argument tokens which is a syntax tree node. This allows the resulting Error to attempt to span all tokens inside of tokens. While you would typically be able to use the Spanned trait with the above Error::new constructor, implementation limitations today mean that Error::new_spanned may provide a higher-quality error message on stable Rust.

When in doubt it's recommended to stick to Error::new (or ParseStream::error)!

pub fn span(&self) -> Span[src]

The source location of the error.

Spans are not thread-safe so this function returns Span::call_site() if called from a different thread than the one on which the Error was originally created.

pub fn to_compile_error(&self) -> TokenStream[src]

Render the error as an invocation of compile_error!.

The parse_macro_input! macro provides a convenient way to invoke this method correctly in a procedural macro.

Trait Implementations

impl Clone for Error[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl From<LexError> for Error[src]

impl Display for Error[src]

impl Debug for Error[src]

impl Error for Error[src]

fn cause(&self) -> Option<&dyn Error>1.0.0[src]

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

fn source(&self) -> Option<&(dyn Error + 'static)>1.30.0[src]

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

Auto Trait Implementations

impl Sync for Error

impl Send for Error

impl Unpin for Error

impl !RefUnwindSafe for Error

impl UnwindSafe for Error

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]