Struct syn::LitStr

pub struct LitStr { /* fields omitted */ }

A UTF-8 string literal: "foo".

This type is available if Syn is built with the "derive" or "full" feature.

Methods

impl LitStr

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

pub fn value(&self) -> String

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

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, Ident, Lit, Meta, MetaNameValue, Path};
use syn::parse::{Error, Result};

// Parses the path from an attribute that looks like:
//
//     #[path = "a::b::c"]
//
// or returns the path `Self` as a default if the attribute is not of
// that form.
fn get_path(attr: &Attribute) -> Result<Path> {
    let default = || Path::from(Ident::new("Self", Span::call_site()));

    let meta = match attr.interpret_meta() {
        Some(meta) => meta,
        None => return Ok(default()),
    };

    if meta.name() != "path" {
        return Ok(default());
    }

    match meta {
        Meta::NameValue(MetaNameValue { lit: Lit::Str(lit_str), .. }) => {
            lit_str.parse()
        }
        _ => {
            let error_span = attr.bracket_token.span;
            let message = "expected #[path = \"...\"]";
            Err(Error::new(error_span, message))
        }
    }
}

pub fn span(&self) -> Span

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

Trait Implementations

impl Token for LitStr

fn peek(cursor: Cursor) -> bool

fn display() -> &'static str

impl Parse for LitStr

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

impl ToTokens for LitStr

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

Write self to the given TokenStream.

fn into_token_stream(self) -> TokenStream

Convert self directly into a TokenStream object.

impl Debug for LitStr

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Clone for LitStr

fn clone(&self) -> LitStr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<LitStr> for Lit

fn from(e: LitStr) -> Lit

Performs the conversion.

impl Eq for LitStr

impl PartialEq for LitStr

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 Hash for LitStr

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].