# Struct syn::LitStr [−] [src]

    pub struct LitStr { /* fields omitted */ }

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

## Implementations

### `impl LitStr` [src]

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

#### `pub fn value(&self) -> String` [src]

#### `pub fn parse<T: Parse>(&self) -> Result<T>` [src]

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>` [src]

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` [src]

#### `pub fn set_span(&mut self, span: Span)` [src]

#### `pub fn suffix(&self) -> &str` [src]

## Trait Implementations

### `impl Clone for LitStr` [src]

#### `fn clone(&self) -> Self` [src]

Returns a copy of the value. Read more

#### `pub fn clone_from(&mut self, source: &Self)`1.0.0 [src]

Performs copy-assignment from `source`. Read more

### `impl From<LitStr> for Lit` [src]

#### `fn from(e: LitStr) -> Lit` [src]

Performs the conversion.

### `impl Parse for LitStr` [src]

#### `fn parse(input: ParseStream<'_>) -> Result<Self>` [src]

### `impl ToTokens for LitStr` [src]

#### `fn to_tokens(&self, tokens: &mut TokenStream)` [src]

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

#### `pub fn to_token_stream(&self) -> TokenStream` [src]

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

#### `pub fn into_token_stream(self) -> TokenStream` [src]

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

### `impl Token for LitStr` [src]

#### `fn peek(cursor: Cursor<'_>) -> bool` [src]

#### `fn display() -> &'static str` [src]

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

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId` [src]

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

### `impl<T> Borrow<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

### `impl<T> From<T> for T` [src]

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U` [src]

Performs the conversion.

### `impl<T> Spanned for T where
T: Spanned + ?Sized,` [src]

#### `pub fn span(&Self) -> Span` [src]

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> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

#### `pub fn to_owned(&self) -> T` [src]

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

#### `pub fn clone_into(&self, target: &mut T)` [src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into`)

recently added

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

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.