Struct Parsed

pub struct Parsed<'a> { /* private fields */ }

Fully parsed Message instead of parsing on demand. Instead of zero-allocation this struct implements zero-copy parsing.

Implements a partially or fully parsed message.

Doesn’t implement the [std::convert::FromStr] trait as its lifetime depends on its source string.

Implementations

impl<'a> Parsed<'a>

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

pub fn prefix(&self) -> Option<&Prefix<'a>>

pub fn params(&self) -> impl Iterator<Item = &Option<&'a str>>

pub fn tags(&self) -> impl Iterator<Item = (&&'a str, &&'a str)>

pub fn tag(&self, key: &str) -> Option<&'a str>

pub fn param(&self, index: usize) -> Option<&'a str>

Returns a param with given original index. If the Parsed instance represents a partially parsed message the original index will preserve.

Usage

use irc_rust::Message;
// A fully parsed message
use irc_rust::tokenizer::PartialCfg;
let message = Message::from("CMD param0 param1 param2");
let parsed = message.parse()?;
assert_eq!(Some("param0"), parsed.param(0));
assert_eq!(Some("param1"), parsed.param(1));
assert_eq!(Some("param2"), parsed.param(2));

// A partially parsed message preserves the original index
let message = Message::from("CMD param0 param1 param2");
let partial = message.parse_partial(PartialCfg {
        params: vec![1],
        ..Default::default()
    })?;
assert_eq!(None, partial.param(0));
assert_eq!(Some("param1"), partial.param(1));
assert_eq!(None, partial.param(2));

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

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

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

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

Trait Implementations

impl<'a> Clone for Parsed<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Parsed<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Parsed<'a>

fn default() -> Parsed<'a>

Returns the “default value” for a type.

impl<'a> PartialEq for Parsed<'a>

fn eq(&self, other: &Parsed<'a>) -> 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> TryFrom<&'a str> for Parsed<'a>

type Error = ParserError

The type returned in the event of a conversion error.

fn try_from(value: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Eq for Parsed<'a>

impl<'a> StructuralPartialEq for Parsed<'a>