Struct bbx::Token

pub struct Token<'a, CustomTy>
where
    CustomTy: Clone,
{
    pub span: &'a str,
    pub start: usize,
    pub kind: TokenKind<'a, CustomTy>,
}

A parsed token, as returned by BBParser::next.

Fields

span: &'a str

start: usize

kind: TokenKind<'a, CustomTy>

Implementations

impl<'a, CustomTy> Token<'a, CustomTy>

where CustomTy: Clone,

Properties of a Token like its arguments or kind.

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

The arguments for this tag, if any are present.

Remarks

This will discard arguments that are purely whitespace as defined by str::trim, and return None in those scenarios.

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

The tag name for this tag.

pub fn is_open(&self, tag_name: &str) -> bool

Whether or not this tag is an open tag of the given type.

Remarks

This ignores the arguments of the tag, use Token::is_open_argless to ensure they’re empty.

pub fn is_open_argless(&self, tag_name: &str) -> bool

Whether or not this tag is an open tag of the given type, without arguments.

pub fn is_close(&self, tag_name: &str) -> bool

Whether or not this tag is a close tag of the given type.

Remarks

This ignores the arguments of the tag, use Token::is_close_argless to ensure they’re empty.

pub fn is_close_argless(&self, tag_name: &str) -> bool

Whether or not this tag is a close tag of the given type, without arguments.

pub fn is_standalone(&self, tag_name: &str) -> bool

Whether or not this tag is a standalone tag of the given type.

Remarks

This ignores the arguments of the tag, use Token::is_standalone_argless to ensure they’re empty.

pub fn is_standalone_argless(&self, tag_name: &str) -> bool

Whether or not this tag is a standalone tag of the given type, without arguments.

pub fn is_text(&self) -> bool

Whether or not this token is just plain text.

impl<'a, CustomTy> Token<'a, CustomTy>

where CustomTy: Clone,

Token “rewriters”, which modify the token in-place.

pub fn rewrite_as_text(&mut self)

Rewrite the token as text, in place, without altering any other properties.

pub fn rewrite_with_opening_tag(&mut self, idx: usize)

Mark the index of a close tag’s opening tag within it, without altering anything else.

Panics

Panics if the tag is not a closing tag.

Trait Implementations

impl<'a, CustomTy> Clone for Token<'a, CustomTy>

where CustomTy: Clone + Clone,

fn clone(&self) -> Token<'a, CustomTy>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, CustomTy> Debug for Token<'a, CustomTy>

where CustomTy: Clone + Debug,

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

Formats the value using the given formatter.