Struct irc_rust::MessageBuilder

pub struct MessageBuilder<'a> { /* fields omitted */ }

A MessageBuilder for a simpler generation of a message instead of building an string first.

Implementations

impl<'a> Message<'a>

pub fn new(command: &'a str) -> Self

Creates a new empty builder.

pub fn command(self, cmd: &'a str) -> Message<'a>

Set the command.

Panics

Panics if cmd is empty.

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

Set a tag.

Panics

Panics if key is empty. value is allowed to be empty.

pub fn prefix(
    self,
    name: &'a str,
    user: Option<&'a str>,
    host: Option<&'a str>
) -> Message<'a>

Set a prefix name.

Panics

Panics if name is empty, user or host == Some(“”) or user is some and host is none.

pub fn param(self, param: &'a str) -> Message<'a>

Add a param.

Panics

Panics if param is empty.

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

Set a param at the given index. If the index is below 0, it won’t be set. If index >= length of the existing parameters it will be added to the end but not set as trailing. This doesn’t allow to set the trailing parameter.

Panics

Panics if param is empty.

pub fn remove_param(self, index: usize) -> Message<'a>

pub fn trailing(self, trailing: &'a str) -> Message<'a>

pub fn build(self) -> Message

Create a Message instance and return if valid.

Trait Implementations

impl<'a> Clone for Message<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Message<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Message<'a>

fn default() -> Message<'a>

Returns the “default value” for a type.

impl<'a> Eq for Message<'a>

impl<'a> PartialEq<Message<'a>> for Message<'a>

fn eq(&self, other: &Message<'a>) -> bool

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

fn ne(&self, other: &Message<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for Message<'a>

impl<'a> StructuralPartialEq for Message<'a>