Enum parsel::ast::Lit

source · [−]

pub enum Lit {
    Bool(LitBool),
    Byte(LitByte),
    Int(LitInt),
    Uint(LitUint),
    Float(LitFloat),
    Char(LitChar),
    Str(LitStr),
    ByteStr(LitByteStr),
}

Expand description

Represents any literal value.

The following is a lazy doc-test for ensuring that the Span of literals is preserved when converted between parsel::ast::Lit and syn::Lit.

// This deliberately uses `parse_str()` instead of `parse_quote!{}`
// because the former results in meaningful `Span` values, while
// the latter would cause every token to be spanned to the call site.
let source = r#"
true
   false  6.283
  100000023456         b'\xa3'
      "foo bar baz" - 74819253
   -99887766554433221100
    b"This is a byte string! A literal one."
"#;
let parsel: Many<Lit> = parsel::parse_str(source).unwrap();
let syn: Many<syn::Lit> = parsel::parse_str(source).unwrap();

let parsel_strings: Vec<_> = parsel
    .iter()
    .map(Lit::to_string)
    .collect();
let syn_strings: Vec<_> = syn
    .iter()
    .map(|lit| -> String {
        // if we simply used `TokenStream::to_string()` here, then multi-token
        // negative literals would fail the test since their representation
        // sometimes includes a space between the sign and the digits.
        lit.to_token_stream().into_iter().map(|tt| tt.to_string()).collect()
    })
    .collect();

assert_eq!(parsel_strings, syn_strings);

let parsel_spans: Vec<_> = parsel
    .iter()
    .map(Lit::span)
    .map(|span| (span.start(), span.end()))
    .collect();
let syn_spans: Vec<_> = syn
    .iter()
    .map(syn::Lit::span)
    .map(|span| (span.start(), span.end()))
    .collect();

assert_eq!(parsel_spans, syn_spans);

let parsel_converted_spans: Vec<_> = parsel
    .into_iter()
    .map(|lit| syn::Lit::from(lit).span())
    .map(|span| (span.start(), span.end()))
    .collect();
let syn_converted_spans: Vec<_> = syn
    .into_iter()
    .map(|lit| Lit::try_from(lit).unwrap().span())
    .map(|span| (span.start(), span.end()))
    .collect();

assert_eq!(parsel_converted_spans, syn_converted_spans);

Variants

`Bool(LitBool)`

`Byte(LitByte)`

`Int(LitInt)`

`Uint(LitUint)`

`Float(LitFloat)`

`Char(LitChar)`

`Str(LitStr)`

`ByteStr(LitByteStr)`

Implementations

impl Lit

pub fn span(&self) -> Span

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

Trait Implementations

impl Clone for Lit

fn clone(&self) -> Lit

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for Lit

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

Formats the value using the given formatter. Read more

impl Display for Lit

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

Formats the value using the given formatter. Read more

impl From<&[u8]> for Lit

fn from(value: &[u8]) -> Self

Converts to this type from the input type.

impl From<&str> for Lit

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<Box<[u8], Global>> for Lit

fn from(value: Box<[u8]>) -> Self

Converts to this type from the input type.

impl From<Box<str, Global>> for Lit

fn from(value: Box<str>) -> Self

Converts to this type from the input type.

impl From<Cow<'_, [u8]>> for Lit

fn from(value: Cow<'_, [u8]>) -> Self

Converts to this type from the input type.

impl From<Cow<'_, str>> for Lit

fn from(value: Cow<'_, str>) -> Self

Converts to this type from the input type.

impl From<Lit> for Lit

fn from(lit: Lit) -> Self

Converts to this type from the input type.

impl From<LitBool> for Lit

fn from(lit: LitBool) -> Self

Converts to this type from the input type.

impl From<LitByte> for Lit

fn from(lit: LitByte) -> Self

Converts to this type from the input type.

impl From<LitByteStr> for Lit

fn from(lit: LitByteStr) -> Self

Converts to this type from the input type.

impl From<LitChar> for Lit

fn from(lit: LitChar) -> Self

Converts to this type from the input type.

impl From<LitFloat> for Lit

fn from(lit: LitFloat) -> Self

Converts to this type from the input type.

impl From<LitInt> for Lit

fn from(lit: LitInt) -> Self

Converts to this type from the input type.

impl From<LitStr> for Lit

fn from(lit: LitStr) -> Self

Converts to this type from the input type.

impl From<LitUint> for Lit

fn from(lit: LitUint) -> Self

Converts to this type from the input type.

impl From<NotNan<f64>> for Lit

fn from(value: NotNan<f64>) -> Self

Converts to this type from the input type.

impl From<String> for Lit

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8, Global>> for Lit

fn from(value: Vec<u8>) -> Self

Converts to this type from the input type.

impl From<bool> for Lit

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<char> for Lit

fn from(value: char) -> Self

Converts to this type from the input type.

impl From<i128> for Lit

fn from(value: i128) -> Self

Converts to this type from the input type.

impl From<u128> for Lit

fn from(value: u128) -> Self

Converts to this type from the input type.

impl From<u8> for Lit

fn from(value: u8) -> Self

Converts to this type from the input type.

impl FromStr for Lit

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self>

Parses a string s to return a value of this type. Read more

impl Hash for Lit

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

impl Parse for Lit

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

impl PartialEq<Lit> for Lit

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

This method tests for self and other values to be equal, and is used by ==. Read more

1.0.0 · source

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

impl ToTokens for Lit

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

Write self to the given TokenStream. Read more

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object. Read more

fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object. Read more

impl TryFrom<Lit> for Lit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(lit: Lit) -> Result<Self>

Performs the conversion.

impl TryFrom<f64> for Lit

type Error = FloatIsNan

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Lit

impl StructuralEq for Lit

impl StructuralPartialEq for Lit

Auto Trait Implementations

impl RefUnwindSafe for Lit

impl !Send for Lit

impl !Sync for Lit

impl Unpin for Lit

impl UnwindSafe for Lit

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> 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.

impl<T> Spanned for Twhere
T: Spanned + ?Sized,

fn span(&self) -> Span

Returns a Span covering the complete contents of this syntax tree node, or Span::call_site() if this node is empty. Read more

impl<T> SpannedExt for Twhere
T: Spanned + ?Sized,

fn byte_range(&self, source: &str) -> Range<usize>

TODO(H2CO3): a faster, less naive implementation would be great. We should use the byte offset of start to compute that of end, sparing the double scan of the source up until the start location.

let source = r#"
   -3.667
  1248  "string ű literal"
      "wíőzs"
"#;
let tokens: Many<Lit> = source.parse()?;

assert_eq!(tokens.len(), 4);
assert_eq!(tokens[0].byte_range(source),  4..10);
assert_eq!(tokens[1].byte_range(source), 13..17);
assert_eq!(tokens[2].byte_range(source), 19..38);
assert_eq!(tokens[3].byte_range(source), 45..54);

fn char_range(&self, source: &str) -> Range<usize>

TODO(H2CO3): a faster, less naive implementation would be great. We should use the char offset of start to compute that of end, sparing the double scan of the source up until the start location.

let source = r#"
   -3.667
  1248  "string ű literal"
      "wíőzs"
"#;
let tokens: Many<Lit> = source.parse()?;

assert_eq!(tokens.len(), 4);
assert_eq!(tokens[0].char_range(source),  4..10);
assert_eq!(tokens[1].char_range(source), 13..17);
assert_eq!(tokens[2].char_range(source), 19..37);
assert_eq!(tokens[3].char_range(source), 44..51);

fn format_span(&self) -> SpanDisplay

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

default fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> 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<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.