Struct circe::Client

pub struct Client { /* fields omitted */ }

An IRC client

Implementations

impl Client

pub fn new(config: Config) -> Result<Self, Error>

Creates a new client with a given config

let mut client = Client::new(config)?;

Errors if the client could not connect to the given host.

pub fn identify(&mut self) -> Result<(), Error>

Identify user and join the specified channels

client.identify()?;

Errors if the client could not write to the stream.

pub fn read(&mut self) -> Result<Command, ()>

Read data coming from the IRC as a Command

if let Ok(ref command) = client.read() {
    if let Command::OTHER(line) = command {
        print!("{}", line);
    }
}

Errors if there are no new messages. This should not be taken as an actual Error, because nothing went wrong.

pub fn write_command(&mut self, command: Command) -> Result<(), Error>

Send a Command to the IRC

client.write_command(Command::PRIVMSG("#main".to_string(), "Hello".to_string()))?;

Errors if the stream could not write.

pub fn send_privmsg(
    &mut self,
    channel: &str,
    message: &str
) -> Result<(), Error>

Helper function for sending PRIVMSGs. This makes

client.send_privmsg("#main", "Hello")?;

equivalent to

client.write_command(Command::PRIVMSG("#main".to_string(), "Hello".to_string()))?;

pub fn send_join(&mut self, channel: &str) -> Result<(), Error>

Helper function for sending JOINs. This makes

client.send_join("#main")?;

equivalent to

client.write_command(Command::JOIN("#main".to_string()))?;

pub fn send_mode(
    &mut self,
    target: &str,
    mode: Option<&str>
) -> Result<(), Error>

Helper function for sending MODEs. This makes

client.send_mode("test", Some("+B"))?;

equivalent to

client.write_command(Command::MODE("test".to_string(), Some("+B".to_string())))?;