Struct Trivia 

pub struct Trivia {
    pub kind: TriviaKind,
    pub span: Span,
}

A comment retained alongside a lexical atom. Struct generated by strutuct! for Trivia.

Fields

kind: TriviaKind

The kind. Field Trivia::kind generated by strutuct!.

span: Span

The span. Field Trivia::span generated by strutuct!.

Implementations

impl Trivia

pub fn from_span(kind: TriviaKind, span: Span) -> Self

Creates trivia from its category and source span.

pub fn new(kind: TriviaKind, text: impl Into<Arc<str>>, span: Span) -> Self

Creates trivia from its category, exact text, and span.

pub fn kind(&self) -> TriviaKind

Returns the trivia category.

pub fn text(&self) -> &str

Returns the trivia exactly as it appeared in source.

Panics

Panics when sources cannot resolve this trivia’s span.

Trait Implementations

impl Clone for Trivia

fn clone(&self) -> Trivia

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Trivia

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

Formats the value using the given formatter.

impl Eq for Trivia

impl FromIterator<Trivia> for TrailingTrivia

fn from_iter<T: IntoIterator<Item = Trivia>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<Trivia> for LeadingTrivia

fn from_iter<T: IntoIterator<Item = Trivia>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Trivia

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Lex for Trivia

fn to_tokens(&self, output: &mut TokenStream)

Appends this value’s token trees to output.

fn to_token_stream(&self) -> TokenStream

Emits this value into a fresh token stream.

fn to_m2(&self) -> String

Renders this value as normalized Macaulay2 source.

impl PartialEq for Trivia

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

Equality operator ==.

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

Inequality operator !=.

impl PrettyTree for Trivia

fn pretty_tree(&self) -> PrettyNode

Builds the presentation node for this syntax value.

impl Spanned for Trivia

fn try_span(&self) -> Option<Span>

Returns the smallest span covering this value, when its constituents share one source snapshot.

fn span(&self) -> Span

Returns the smallest span covering this value.

fn expect_span(&self) -> Span

Returns this value’s span when one source snapshot covers it.

impl StructuralPartialEq for Trivia