Struct ellidri::message::ReplyBuffer

pub struct ReplyBuffer { /* fields omitted */ }

An helper to build IRC replies.

IRC replies are IRC messages that have the domain of the server as prefix, and the nickname of the client as first parameter.

Example

let mut response = ReplyBuffer::new("ellidri.dev", "nickname");

response.message("nick!user@127.0.0.1", Command::Topic)
    .param("#hall")
    .trailing_param("Welcome to new users!");
response.reply(rpl::TOPIC)
    .param("#hall")
    .trailing_param("Welcome to new users!");

let result = response.build();
assert_eq!(&result, ":nick!user@127.0.0.1 TOPIC #hall :Welcome to new users!\r\n\
:ellidri.dev 332 nickname #hall :Welcome to new users!\r\n");

On allocation

Allocation only occurs on ReplyBuffer::reply and ReplyBuffer::message calls. These functions reseve MESSAGE_LENGTH prior to writing on the internal buffer.

Usage note

This buffer uses thread-local storage to store the domain and the nickname, to reduce the number of allocations. Therefore, the user must not make two ReplyBuffers at the same time, otherwise nicknames and domains will be mixed.

Methods

impl ReplyBuffer

pub fn new(domain: &str, nickname: &str) -> Self

Creates a new ReplyBuffer and initialize the thread-local storage with the given domain and nickname.

pub fn is_empty(&self) -> bool

Whether the buffer has messages in it or not.

Example

let empty = ReplyBuffer::new("ellidri.dev", "ser");
let mut not_empty = ReplyBuffer::new("ellidri.dev", "ser");

not_empty.reply(rpl::ERR_NOMOTD);

assert_eq!(empty.is_empty(), true);
assert_eq!(not_empty.is_empty(), false);

pub fn reply<C>(&mut self, r: C) -> MessageBuffer where
    C: Into<Command>, 

Appends a reply to the buffer.

This will push the domain, the reply and the nickname of the client, and then return the resulting MessageBuffer.

This function may allocate to reserve space for the message.

Example

let mut response = ReplyBuffer::new("ellidri.dev", "ser");

response.reply(rpl::WELCOME).trailing_param("Welcome to IRC, ser");

assert_eq!(&response.build(), ":ellidri.dev 001 ser :Welcome to IRC, ser\r\n");

pub fn message<C>(&mut self, prefix: &str, command: C) -> MessageBuffer where
    C: Into<Command>, 

Appends a prefixed message like you would do with a Buffer.

This function may allocate to reserve space for the message.

Example

let mut response = ReplyBuffer::new("ellidri.dev", "ser");

response.message("unneeded_prefix", Command::Admin);

assert_eq!(&response.build(), ":unneeded_prefix ADMIN\r\n");

pub fn build(self) -> String

Consumes the buffer and returns the underlying String.