Struct PrivmsgBuilder

pub struct PrivmsgBuilder { /* private fields */ }

A builder for constructing a Message or Privmsg (and its raw format)

use twitch_message::builders::PrivmsgBuilder;
use twitch_message::messages::{Privmsg, Message, MessageKind};

let builder = PrivmsgBuilder::default()
    .channel("museun")
    .sender("shaken_bot")
    .data("~ Kappa");

let expected = ":shaken_bot!shaken_bot@shaken_bot.tmi.twitch.tv PRIVMSG #museun :~ Kappa\r\n";

let msg: Message<'_> = builder.clone().finish_message()?;
assert_eq!(msg.raw, expected);
assert_eq!(msg.kind, MessageKind::Privmsg);

let pm: Privmsg<'_> = builder.finish_privmsg()?;
assert_eq!(pm.raw, expected);

Implementations

impl PrivmsgBuilder

pub fn new() -> Self

Create a new builder

pub fn tags(self, tags: Tags<'_>) -> Self

Give it some optional tags

pub fn sender(self, sender: &str) -> Self

Give it the required sender

pub fn channel(self, channel: &str) -> Self

Give it the required channel

pub fn data(self, data: &str) -> Self

Give it the required data

pub fn finish_privmsg(self) -> Result<Privmsg<'static>, PrivmsgBuilderError>

Construct a Privmsg from this builder

pub fn finish_message(self) -> Result<Message<'static>, PrivmsgBuilderError>

Construct a Message from this builder

Trait Implementations

impl Clone for PrivmsgBuilder

fn clone(&self) -> PrivmsgBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for PrivmsgBuilder

fn default() -> PrivmsgBuilder

Returns the “default value” for a type.