# Struct syn::LitStr

source · [−]

    pub struct LitStr { /* private fields */ }

Expand description

A UTF-8 string literal: `"foo"`.

## Implementations

source

### impl LitStr

source

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

source

#### pub fn value(&self) -> String

source

#### 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))
            }
        }
    }

source

#### 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)?;

source

#### pub fn span(&self) -> Span

source

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

source

#### pub fn suffix(&self) -> &str

source

#### pub fn token(&self) -> Literal

## Trait Implementations

source

### impl Clone for LitStr

source

#### fn clone(&self) -> Self

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

source

### impl From<LitStr> for Lit

source

#### fn from(e: LitStr) -> Lit

Converts to this type from the input type.

source

### impl Parse for LitStr

source

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

source

### impl ToTokens for LitStr

source

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

Write `self` to the given `TokenStream`. Read more

source

#### fn to_token_stream(&self) -> TokenStream

Convert `self` directly into a `TokenStream` object. Read more

source

#### fn into_token_stream(self) -> TokenStream

Convert `self` directly into a `TokenStream` object. Read more

source

### impl Token for LitStr

## Auto Trait Implementations

### impl RefUnwindSafe for LitStr

### impl !Send for LitStr

### impl !Sync for LitStr

### impl Unpin for LitStr

### impl UnwindSafe for LitStr

## Blanket Implementations

source

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

source

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more

source

### impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

### impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

### impl<T> From<T> for T

const: unstable · source

#### fn from(t: T) -> T

Returns the argument unchanged.

source

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

source

### impl<T> Spanned for T where
T: Spanned + ?Sized,

source

#### 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

source

### impl<T> ToOwned for T where
T: Clone,

#### type Owned = T

The resulting type after obtaining ownership.

source

#### fn to_owned(&self) -> T

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

source

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

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

source

### impl<T, U> TryFrom<U> for T where
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.

source

### impl<T, U> TryInto<U> for T where
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.