Struct ellidri_tokens::Buffer

pub struct Buffer { /* fields omitted */ }

Helper to build IRC messages.

The Buffer is used to ease the creation of strings representing valid IRC messages. If you mainly need to send replies, ReplyBuffer might be a better fit for you.

Example

let mut response = Buffer::new();

response.message("nick!user@127.0.0.1", Command::Topic)
    .param("#hall")
    .trailing_param("Welcome to new users!");
response.message("ellidri.dev", rpl::TOPIC)
    .param("nickname")
    .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 Buffer::message calls. These functions reseve MESSAGE_LENGTH prior to writing on the internal buffer.

Methods

impl Buffer

pub fn new() -> Self

Creates a Buffer. Does not allocate.

pub fn with_capacity(capacity: usize) -> Self

pub fn is_empty(&self) -> bool

Whether the buffer is empty.

Example

let empty = Buffer::new();
let mut not_empty = Buffer::new();

not_empty.message("ellidri.dev", Command::Motd);

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

pub fn get(&self) -> &str

Returns a reference to the underlying String.

pub fn clear(&mut self)

Empties the buffer.

pub fn len(&self) -> usize

pub fn capacity(&self) -> usize

pub fn reserve(&mut self, capacity: usize)

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

Appends an IRC message with a prefix to the buffer.

This function may allocate to reserve space for the message.

Example

let mut response = Buffer::new();

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

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

pub fn tagged_message(&mut self, client_tags: &str) -> TagBuffer

Start building an IRC message with tags.

Server tags are filtered from client_tags, so that only tags with the client prefix + are appended to the buffer.

The length of the resulting tags (@ and included) is written to tags_len.

TODO example

pub fn build(self) -> String

Consumes the Buffer and returns the underlying String.

Trait Implementations

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Default for Buffer

fn default() -> Self

Returns the "default value" for a type.

impl From<String> for Buffer

fn from(val: String) -> Self

Performs the conversion.