Skip to main content

Token

Struct Token 

Source
#[non_exhaustive]
pub struct Token { pub kind: TokenKind, pub value: String, pub line: usize, pub col: usize, pub is_quoted: bool, pub preceding_space: bool, pub preceding_whitespace: String, pub subst: Option<SubstPayload>, }
Expand description

A single token produced by the lexer.

Token is publicly re-exported as hocon::Token for the narrow surface that integration tests and diagnostic tooling need (per the advisory in lib.rs). It is marked #[non_exhaustive]: downstream code MUST NOT construct Token via struct-literal syntax and should treat it as inspect-only. This frees the lexer to add new metadata fields (e.g. preceding_whitespace in v1.5.3) without further source breaks.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§kind: TokenKind§value: String§line: usize§col: usize§is_quoted: bool§preceding_space: bool

True if preceded by whitespace OR a comment (concat detection, S10.5 / S10.8).

§preceding_whitespace: String

Literal preceding-whitespace chars consumed since the previous token. Used by parse_key to preserve path-expression whitespace per E13 — for a b. c = 1 the ’ ’ before c becomes a leading-space prefix on the post-dot segment.

Note: preceding_space may be true while preceding_whitespace is empty when the token is preceded only by a comment (no literal WS chars). The boolean is the right signal for concat detection; the string is the right signal for path-WS preservation. The comment-only shape fires for the newline token emitted after // foo\n / # foo\n; non-newline tokens participating in concat / path-WS contexts are always either preceded by literal WS chars OR follow a newline that resets the buffer.

§subst: Option<SubstPayload>

Trait Implementations§

Source§

impl Clone for Token

Source§

fn clone(&self) -> Token

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Token

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Token

§

impl RefUnwindSafe for Token

§

impl Send for Token

§

impl Sync for Token

§

impl Unpin for Token

§

impl UnsafeUnpin for Token

§

impl UnwindSafe for Token

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,

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, 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.