LitKind in rustc_ast::ast - Rust
Description: This type is used within both `ast::MetaItemLit` and `hir::Lit`.

Skip to main content

## LitKind

# Enum LitKind

Source

    pub enum LitKind {
        Str(Symbol, StrStyle),
        ByteStr(ByteSymbol, StrStyle),
        CStr(ByteSymbol, StrStyle),
        Byte(u8),
        Char(char),
        Int(Pu128, LitIntType),
        Float(Symbol, LitFloatType),
        Bool(bool),
        Err(ErrorGuaranteed),
    }

Expand description

This type is used within both `ast::MetaItemLit` and `hir::Lit`.

Note that the entire literal (including the suffix) is considered when deciding the `LitKind`. This means that float literals like `1f32` are classified by this type as `Float`. This is different to `token::LitKind` which does not consider the suffix.

## Variants§

§

### Str(Symbol, StrStyle)

A string literal (`"foo"`). The symbol is unescaped, and so may differ from the original token’s symbol.

§

### ByteStr(ByteSymbol, StrStyle)

A byte string (`b"foo"`). The symbol is unescaped, and so may differ from the original token’s symbol.

§

### CStr(ByteSymbol, StrStyle)

A C String (`c"foo"`). Guaranteed to only have `\0` at the end. The symbol is unescaped, and so may differ from the original token’s symbol.

§

### Byte(u8)

A byte char (`b'f'`).

§

### Char(char)

A character literal (`'a'`).

§

### Int(Pu128, LitIntType)

An integer literal (`1`).

§

### Float(Symbol, LitFloatType)

A float literal (`1.0`, `1f64` or `1E10f64`). The pre-suffix part is stored as a symbol rather than `f64` so that `LitKind` can impl `Eq` and `Hash`.

§

### Bool(bool)

A boolean literal (`true`, `false`).

§

### Err(ErrorGuaranteed)

Placeholder for a literal that wasn’t well-formed in some way.

## Implementations§

Source§

### impl LitKind

Source

#### pub fn from_token_lit(lit: Lit) -> Result<LitKind, LitError>

Converts literal token into a semantic literal.

Source§

### impl LitKind

Source

#### pub fn str(&self) -> Option<Symbol>

Source

#### pub fn is_str(&self) -> bool

Returns `true` if this literal is a string.

Source

#### pub fn is_bytestr(&self) -> bool

Returns `true` if this literal is byte literal string.

Source

#### pub fn is_numeric(&self) -> bool

Returns `true` if this is a numeric literal.

Source

#### pub fn is_unsuffixed(&self) -> bool

Returns `true` if this literal has no suffix. Note: this will return true for literals with prefixes such as raw strings and byte strings.

Source

#### pub fn is_suffixed(&self) -> bool

Returns `true` if this literal has a suffix.

## Trait Implementations§

Source§

### impl Clone for LitKind

Source§

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

Returns a duplicate 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 Debug for LitKind

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<__D: SpanDecoder> Decodable<__D> for LitKind

Source§

#### fn decode(__decoder: &mut __D) -> Self

Source§

### impl Display for LitKind

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl<__E: SpanEncoder> Encodable<__E> for LitKind

Source§

#### fn encode(&self, __encoder: &mut __E)

Source§

### impl Hash for LitKind

Source§

#### fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given `Hasher`. Read more
1.3.0 · Source§

#### fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given `Hasher`. Read more
Source§

### impl<__CTX> HashStable<__CTX> for LitKind
where __CTX: HashStableContext,

Source§

#### fn hash_stable(&self, __hcx: &mut __CTX, __hasher: &mut StableHasher)

Source§

### impl PartialEq for LitKind

Source§

#### fn eq(&self, other: &LitKind) -> bool

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

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

### impl Copy for LitKind

Source§

### impl Eq for LitKind

Source§

### impl StructuralPartialEq for LitKind

## Auto Trait Implementations§

§

### impl DynSend for LitKind

§

### impl DynSync for LitKind

§

### impl Freeze for LitKind

§

### impl RefUnwindSafe for LitKind

§

### impl Send for LitKind

§

### impl Sync for LitKind

§

### impl Unpin for LitKind

§

### impl UnsafeUnpin for LitKind

§

### impl UnwindSafe for LitKind

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
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,

Source§

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

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

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

Source§

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

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

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> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<T> MutVisitorResult for T

Source§

#### type Result = ()

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

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

Source§

#### 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> ToString for T
where T: Display + ?Sized,

Source§

#### fn to_string(&self) -> String

Converts the given value to a `String`. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
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>,

Source§

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

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes

Size for each variant:

- `Str`: 7 bytes
- `ByteStr`: 7 bytes
- `CStr`: 7 bytes
- `Byte`: 1 byte
- `Char`: 7 bytes
- `Int`: 23 bytes
- `Float`: 7 bytes
- `Bool`: 1 byte
- `Err`: 0 bytes