Struct StringLit

pub struct StringLit<B: Buffer> {
    raw: B,
    value: Option<String>,
    num_hashes: Option<u32>,
    start_suffix: usize,
}

A string or raw string literal, e.g. "foo", "Grüße" or r#"a🦊c"d🦀f"#.

See the reference for more information.

Fields

raw: B

The raw input.

value: Option<String>

The string value (with all escapes unescaped), or None if there were no escapes. In the latter case, the string value is in raw.

num_hashes: Option<u32>

The number of hash signs in case of a raw string literal, or None if it’s not a raw string literal.

start_suffix: usize

Start index of the suffix or raw.len() if there is no suffix.

Implementations

impl<B: Buffer> StringLit<B>

pub fn parse(input: B) -> Result<Self, ParseError>

Parses the input as a (raw) string literal. Returns an error if the input is invalid or represents a different kind of literal.

pub fn value(&self) -> &str

Returns the string value this literal represents (where all escapes have been turned into their respective values).

pub fn into_value(self) -> B::Cow

Like value but returns a potentially owned version of the value.

The return value is either Cow<'static, str> if B = String, or Cow<'a, str> if B = &'a str.

pub fn suffix(&self) -> &str

The optional suffix. Returns "" if the suffix is empty/does not exist.

pub fn is_raw_string(&self) -> bool

Returns whether this literal is a raw string literal (starting with r).

pub fn raw_input(&self) -> &str

Returns the raw input that was passed to parse.

pub fn into_raw_input(self) -> B

Returns the raw input that was passed to parse, potentially owned.

fn inner_range(&self) -> Range<usize>

The range within self.raw that excludes the quotes and potential r#.

impl StringLit<&str>

pub fn into_owned(self) -> StringLit<String>

Makes a copy of the underlying buffer and returns the owned version of Self.

Trait Implementations

impl<B: Clone + Buffer> Clone for StringLit<B>

fn clone(&self) -> StringLit<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + Buffer> Debug for StringLit<B>

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

Formats the value using the given formatter.

impl<B: Buffer> Display for StringLit<B>

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

Formats the value using the given formatter.

impl<B: Buffer> From<StringLit<B>> for Literal

fn from(l: StringLit<B>) -> Self

Converts to this type from the input type.

impl<B: Buffer> From<StringLit<B>> for Literal<B>

fn from(src: StringLit<B>) -> Self

Converts to this type from the input type.

impl<B: PartialEq + Buffer> PartialEq for StringLit<B>

fn eq(&self, other: &StringLit<B>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&Literal> for StringLit<String>

type Error = InvalidToken

The type returned in the event of a conversion error.

fn try_from(src: &Literal) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&TokenTree> for StringLit<String>

type Error = InvalidToken

The type returned in the event of a conversion error.

fn try_from(tt: &TokenTree) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Literal> for StringLit<String>

type Error = InvalidToken

The type returned in the event of a conversion error.

fn try_from(src: Literal) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TokenTree> for StringLit<String>

type Error = InvalidToken

The type returned in the event of a conversion error.

fn try_from(tt: TokenTree) -> Result<Self, Self::Error>

Performs the conversion.

impl<B: Eq + Buffer> Eq for StringLit<B>

impl<B: Buffer> StructuralPartialEq for StringLit<B>