Struct const_irc_message_parser::parameters::Parameters

pub struct Parameters<'msg> { /* private fields */ }

All the parameters of an IrcMsg.

Implementations

impl<'msg> Parameters<'msg>

pub const fn parse(input: &'msg [u8]) -> Result<Option<Self>, ParametersError>

Generates Parameters from a slice of bytes.

Errors

Will return Err if the input contains an invalid character as per the IRC Client Protocol Specification.

pub const fn count(&self) -> usize

Returns the amount of parameters in Parameters.

pub const fn content(&self) -> ContentType<'_>

Returns all the parameters as a ContentType.

This includes the : before the last parameter if present.

pub const fn extract_first(&self) -> ContentType<'_>

Returns the first parameter as a ContentType.

Does not include : for the trailing parameter.

pub const fn extract_last(&self) -> ContentType<'_>

Returns the last parameter as a ContentType.

Does not include : for the trailing parameter.

pub const fn extract_specific( &self, target_index: usize ) -> Option<ContentType<'_>>

Returns the requested parameter as a ContentType at the specified index.

Index starts at 0. If out of bounds it returns None. Does not include : for the trailing parameter.

pub const fn is_valid_uft8(&self) -> bool

Checks whether the Parameters contains non-utf8 bytes.

Trait Implementations

impl<'msg> Clone for Parameters<'msg>

fn clone(&self) -> Parameters<'msg>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'msg> Debug for Parameters<'msg>

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

Formats the value using the given formatter.

impl<'msg> Display for Parameters<'msg>

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

Formats the value using the given formatter.

impl<'msg> PartialEq for Parameters<'msg>

fn eq(&self, other: &Parameters<'msg>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'msg> Copy for Parameters<'msg>

impl<'msg> Eq for Parameters<'msg>

impl<'msg> StructuralPartialEq for Parameters<'msg>