Struct Token 

pub struct Token {
    pub token_type: TokenType,
    pub start_position: Position,
    pub end_position: Position,
}

Represents a YAML token with position information

Fields

token_type: TokenType

The type of token

start_position: Position

Start position of the token

end_position: Position

End position of the token

Implementations

impl Token

pub const fn new( token_type: TokenType, start_position: Position, end_position: Position, ) -> Self

Create a new token

pub const fn simple(token_type: TokenType, position: Position) -> Self

Create a simple token at a single position

pub const fn token_type(&self) -> &TokenType

Get the token type

pub const fn start_position(&self) -> Position

Get the start position

pub const fn end_position(&self) -> Position

Get the end position

pub const fn is_scalar(&self) -> bool

Check if this is a scalar token

pub fn as_scalar(&self) -> Option<&str>

Get scalar value if this is a scalar token

pub fn as_scalar_with_style(&self) -> Option<(&str, QuoteStyle)>

Get scalar value and quote style if this is a scalar token

pub const fn is_flow_collection_start(&self) -> bool

Check if this is a flow collection start token

pub const fn is_flow_collection_end(&self) -> bool

Check if this is a flow collection end token

pub const fn is_block_collection_start(&self) -> bool

Check if this is a block collection start token

pub const fn is_document_boundary(&self) -> bool

Check if this is a document boundary token

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl Display for Token

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

Formats the value using the given formatter.

impl PartialEq for Token

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

impl Eq for Token

impl StructuralPartialEq for Token