Struct CommentedToken

pub struct CommentedToken<'a> {
    pub token: Token<'a>,
    pub offset: usize,
    pub leading_comments: Option<Vec<&'a str>>,
    pub inline_comment: Option<&'a str>,
}

Representation of a token.

This represents a single token in an R program along with the line on which it occurs and the column offset. Additionally, it stores the comments that are associated with the token.

Fields

token: Token<'a>

The actual token stored in this struct.

offset: usize

The column offset of the start of this token.

leading_comments: Option<Vec<&'a str>>

Preceding comments.

inline_comment: Option<&'a str>

Trailing inline comment.

Implementations

impl<'a> CommentedToken<'a>

pub fn new(token: Token<'a>, offset: usize) -> Self

pub fn with_comments( token: Token<'a>, offset: usize, leading_comments: Option<Vec<&'a str>>, inline_comment: Option<&'a str>, ) -> Self

Trait Implementations

impl<'a> Clone for CommentedToken<'a>

fn clone(&self) -> CommentedToken<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CommentedToken<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for CommentedToken<'a>

type Target = Token<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a> Display for CommentedToken<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for CommentedToken<'a>

When comparing two tokens, only the token itself is compared. The line and offset are ignored.

fn eq(&self, other: &Self) -> 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.