Struct syn::LitStr

pub struct LitStr { /* fields omitted */ }

A UTF-8 string literal: "foo".

Implementations

impl LitStr

pub fn new(value: &str, span: Span) -> Self

pub fn value(&self) -> String

pub fn parse<T: Parse>(&self) -> Result<T>

This is supported on crate feature parsing only.

Parse a syntax tree node from the content of this string literal.

All spans in the syntax tree will point to the span of this LitStr.

Example

use proc_macro2::Span;
use syn::{Attribute, Error, Ident, Lit, Meta, MetaNameValue, Path, Result};

// Parses the path from an attribute that looks like:
//
//     #[path = "a::b::c"]
//
// or returns `None` if the input is some other attribute.
fn get_path(attr: &Attribute) -> Result<Option<Path>> {
    if !attr.path.is_ident("path") {
        return Ok(None);
    }

    match attr.parse_meta()? {
        Meta::NameValue(MetaNameValue { lit: Lit::Str(lit_str), .. }) => {
            lit_str.parse().map(Some)
        }
        _ => {
            let message = "expected #[path = \"...\"]";
            Err(Error::new_spanned(attr, message))
        }
    }
}

pub fn parse_with<F: Parser>(&self, parser: F) -> Result<F::Output>

This is supported on crate feature parsing only.

Invoke parser on the content of this string literal.

All spans in the syntax tree will point to the span of this LitStr.

Example

let lit_str: LitStr = /* ... */;

// Parse a string literal like "a::b::c" into a Path, not allowing
// generic arguments on any of the path segments.
let basic_path = lit_str.parse_with(syn::Path::parse_mod_style)?;

pub fn span(&self) -> Span

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

pub fn suffix(&self) -> &str

Trait Implementations

impl Clone for LitStr

This is supported on crate feature clone-impls only.

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 LitStr

This is supported on crate feature extra-traits only.

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

Formats the value using the given formatter.

impl From<LitStr> for Lit

fn from(e: LitStr) -> Lit

Performs the conversion.

impl Hash for LitStr

This is supported on crate feature extra-traits only.

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, 

Feeds a slice of this type into the given Hasher.

impl Parse for LitStr

This is supported on crate feature parsing only.

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

impl PartialEq<LitStr> for LitStr

This is supported on crate feature extra-traits only.

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

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

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

This method tests for !=.

impl ToTokens for LitStr

This is supported on crate feature printing only.

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

Convert self directly into a TokenStream object.

impl Token for LitStr

fn peek(cursor: Cursor<'_>) -> bool

fn display() -> &'static str

impl Eq for LitStr

This is supported on crate feature extra-traits only.