Struct Tokenizer

pub struct Tokenizer<'a, T: State> { /* private fields */ }

Implements a Parser of IRC Messages as described in IRCv3 and RFC 1459.

The tokenizer implements both phases of a parser: Lexical and syntactical analysis. This is required as it implements a Zero-allocation parser which is not allocating anything on the heap and returns the next element based on its state.

Transitions between states are implemented with methods Tokenizer::tags, Tokenizer::prefix, Tokenizer::command, Tokenizer::params and Tokenizer::trailing. Based on the state different parts of the message can be parsed. If some parts of the message are not needed they are skipped by calling the wanted state transition method.

Implementations

impl<'a> Tokenizer<'a, Start>

pub fn new(raw: &'a str) -> Result<Self, ParserError>

pub fn parse_partial( self, cfg: PartialCfg<'a>, ) -> Result<Parsed<'a>, ParserError>

pub fn tags(self) -> Tokenizer<'a, TagsState>

pub fn prefix(self) -> Tokenizer<'a, PrefixState>

pub fn command(self) -> Tokenizer<'a, CommandState>

pub fn params(self) -> Tokenizer<'a, ParamsState>

pub fn trailing(self) -> Tokenizer<'a, TrailingState>

impl<'a> Tokenizer<'a, TagsState>

pub fn as_iter(&mut self) -> IntoTagsIter<'a>

pub fn prefix(self) -> Tokenizer<'a, PrefixState>

pub fn command(self) -> Tokenizer<'a, CommandState>

pub fn params(self) -> Tokenizer<'a, ParamsState>

pub fn trailing(self) -> Tokenizer<'a, TrailingState>

impl<'a> Tokenizer<'a, PrefixState>

pub fn name(&mut self) -> Result<Option<&'a str>, ParserError>

pub fn user(&mut self) -> Result<Option<&'a str>, ParserError>

pub fn host(&mut self) -> Result<Option<&'a str>, ParserError>

pub fn parts(&mut self) -> Result<Option<Prefix<'a>>, ParserError>

Returns None if the prefix is badly formatted or no prefix is present.

pub fn command(self) -> Tokenizer<'a, CommandState>

pub fn params(self) -> Tokenizer<'a, ParamsState>

pub fn trailing(self) -> Tokenizer<'a, TrailingState>

impl<'a> Tokenizer<'a, CommandState>

pub fn command(&mut self) -> Result<&'a str, ParserError>

pub fn params(self) -> Tokenizer<'a, ParamsState>

pub fn trailing(self) -> Tokenizer<'a, TrailingState>

impl<'a> Tokenizer<'a, ParamsState>

pub fn trailing(self) -> Tokenizer<'a, TrailingState>

pub fn as_iter(&mut self) -> IntoParamsIter<'a>

impl<'a> Tokenizer<'a, TrailingState>

pub fn trailing(&self) -> Option<&'a str>

Trait Implementations

impl<'a, T: Clone + State> Clone for Tokenizer<'a, T>

fn clone(&self) -> Tokenizer<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + State> Debug for Tokenizer<'a, T>

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

Formats the value using the given formatter.

impl<'a> IntoIterator for Tokenizer<'a, ParamsState>

type Item = &'a str

The type of the elements being iterated over.

type IntoIter = IntoParamsIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for Tokenizer<'a, TagsState>

type Item = Result<(&'a str, &'a str), ParserError>

The type of the elements being iterated over.

type IntoIter = IntoTagsIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T: PartialEq + State> PartialEq for Tokenizer<'a, T>

fn eq(&self, other: &Tokenizer<'a, T>) -> 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<'a, T: Copy + State> Copy for Tokenizer<'a, T>

impl<'a, T: Eq + State> Eq for Tokenizer<'a, T>

impl<'a, T: State> StructuralPartialEq for Tokenizer<'a, T>