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

Returns error if the client could not connect to the host.

Panics

Panics if the client can’t connect to the given host.

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

Identify user and joins the in the Config specified channels.

client.identify()?;

Errors

Returns error if the client could not write to the stream.

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

Read data coming from the IRC as a commands::Command.

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

Errors

Returns error 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 commands::Command to the IRC.
Not reccomended to use, use the helper functions instead.

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

Errors

Returns error if the client could not write to the stream.

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

Helper function for requesting information about the ADMIN of an IRC server

client.admin("192.168.178.100")?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for setting the users status to AWAY

client.away("AFK")?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for sending PRIVMSGs.

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

Errors

Returns error if the client could not write to the stream.

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

Helper function to INVITE people to a channels

client.invite("liblirc", "#circe")?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for sending JOINs.

client.join("#main")?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for LISTing channels and modes

client.list(None, None)?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for getting all nicknames in a channel

client.names("#main,#circe", None)?;

Errors

Returns error if the client could not write to the stream.

pub fn oper(&mut self, username: &str, password: &str) -> Result<(), Error>

Helper function to try to register as a channel operator

client.oper("username", "password")?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for sending MODEs.

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

Errors

Returns error if the client could not write to the stream.

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

Helper function for leaving channels.

client.part("#main")?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for setting or getting the topic of a channel

client.topic("#main", Some("main channel"))?;

Errors

Returns error if the client could not write to the stream.

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

Helper function for leaving the IRC server and shutting down the TCP stream afterwards.

client.quit(None)?;

Errors

Returns error if the client could not write to the stream.