Enum syn::Lit

#[non_exhaustive]
pub enum Lit {
    Str(LitStr),
    ByteStr(LitByteStr),
    CStr(LitCStr),
    Byte(LitByte),
    Char(LitChar),
    Int(LitInt),
    Float(LitFloat),
    Bool(LitBool),
    Verbatim(Literal),
}

A Rust literal such as a string or integer or boolean.

Syntax tree enum

This type is a syntax tree enum.

Variants (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.

Str(LitStr)

A UTF-8 string literal: "foo".

ByteStr(LitByteStr)

A byte string literal: b"foo".

CStr(LitCStr)

A nul-terminated C-string literal: c"foo".

Byte(LitByte)

A byte literal: b'f'.

Char(LitChar)

A character literal: 'a'.

Int(LitInt)

An integer literal: 1 or 1u16.

Float(LitFloat)

A floating point literal: 1f64 or 1.0e10f64.

Must be finite. May not be infinite or NaN.

Bool(LitBool)

A boolean literal: true or false.

Verbatim(Literal)

A raw token literal not interpreted by Syn.

Implementations

impl Lit

pub fn new(token: Literal) -> Self

Interpret a Syn literal from a proc-macro2 literal.

pub fn suffix(&self) -> &str

pub fn span(&self) -> Span

pub fn set_span(&mut self, span: Span)

Trait Implementations

impl Clone for Lit

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Lit

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

Formats the value using the given formatter.

impl From<LitBool> for Lit

fn from(e: LitBool) -> Lit

Converts to this type from the input type.

impl From<LitByte> for Lit

fn from(e: LitByte) -> Lit

Converts to this type from the input type.

impl From<LitByteStr> for Lit

fn from(e: LitByteStr) -> Lit

Converts to this type from the input type.

impl From<LitCStr> for Lit

fn from(e: LitCStr) -> Lit

Converts to this type from the input type.

impl From<LitChar> for Lit

fn from(e: LitChar) -> Lit

Converts to this type from the input type.

impl From<LitFloat> for Lit

fn from(e: LitFloat) -> Lit

Converts to this type from the input type.

impl From<LitInt> for Lit

fn from(e: LitInt) -> Lit

Converts to this type from the input type.

impl From<LitStr> for Lit

fn from(e: LitStr) -> Lit

Converts to this type from the input type.

impl Hash for Lit

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Parse for Lit

fn parse(input: ParseStream<'_>) -> Result<Self>

impl PartialEq for Lit

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl ToTokens for Lit

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

impl Eq for Lit

impl Token for Lit