Skip to main content

TriviaSink

Struct TriviaSink 

Source
pub struct TriviaSink { /* private fields */ }
Expand description

A sink that collects trivia as the lexer advances. Use TriviaSink::new to create a collecting sink, or TriviaSink::disabled to create a discarding sink.

Implementations§

Source§

impl TriviaSink

Source

pub fn new() -> Self

Create a trivia sink that collects trivia.

Source

pub fn disabled() -> Self

Create a trivia sink that discards trivia (AST mode).

Source

pub fn is_enabled(&self) -> bool

Is this sink collecting trivia?

Source

pub fn record(&mut self, trivia: Trivia)

Record a trivia element. If the sink is disabled, this is a no-op.

Source

pub fn record_line_comment(&mut self, text: &str, span: Span)

Record a line comment.

Source

pub fn record_block_comment(&mut self, text: &str, span: Span)

Record a block comment.

Source

pub fn record_whitespace(&mut self, text: &str, span: Span)

Record whitespace.

Source

pub fn entries(&self) -> &[Trivia]

Get all collected trivia.

Source

pub fn take(&mut self) -> Vec<Trivia>

Take all collected trivia, leaving the sink empty.

Source

pub fn len(&self) -> usize

Number of trivia entries collected.

Source

pub fn is_empty(&self) -> bool

Is the sink empty?

Source

pub fn comments(&self) -> Vec<&Trivia>

Get only the comment trivia (line + block).

Source

pub fn whitespace(&self) -> Vec<&Trivia>

Get only the whitespace trivia.

Trait Implementations§

Source§

impl Clone for TriviaSink

Source§

fn clone(&self) -> Self

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 TriviaSink

Source§

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

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

impl Default for TriviaSink

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,