Struct syn::LitStr

[+] Show declaration

pub struct LitStr { /* fields omitted */ }

[−] Expand description

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>[−]

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>[−]

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)

Trait Implementations

impl Clone for LitStr[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

fn from(e: LitStr) -> Lit[−]

Performs the conversion.

impl Parse for LitStr[+]

[+] Show hidden undocumented items

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

impl ToTokens for LitStr[+]

[+] Show hidden undocumented items

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 Token for LitStr[+]

[+] Show hidden undocumented items

fn peek(cursor: Cursor) -> bool

fn display() -> &'static str