A fork of aatxe/irc Rust crate, improved for IRCv3 support.
Find a file
2015-01-13 04:07:04 -05:00
examples Refactored library in preparation for server work. 2015-01-13 02:39:59 -05:00
src Updated code for line-wrapping. 2015-01-13 04:07:04 -05:00
.gitignore Added some basic data tests. 2014-10-08 18:08:29 -04:00
.travis.yml Updated rust-ci docs token. 2015-01-13 03:13:32 -05:00
Cargo.toml Bumped version number to 0.8.1 with updated documentation links. 2015-01-13 03:39:38 -05:00
mktestconfig.sh Changed config.json to client_config.json. 2015-01-13 03:01:18 -05:00
README.md Bumped version number to 0.8.1 with updated documentation links. 2015-01-13 03:39:38 -05:00
UNLICENSE Added UNLICENSE and contributing guidelines. This library is now public domain. 2014-11-05 02:11:33 -05:00

irc Build Status

A thread-safe IRC library in Rust. The client portion is compliant with RFC 2812 and includes some additional, common features. The server portion is still a work in progress. You can find up-to-date, ready-to-use documentation online here. The documentation is generated with the default features. These are, however, strictly optional and can be disabled accordingly.

Getting Started

To start using this library with cargo, you can simply add irc = "*" to your dependencies to your Cargo.toml file. You'll likely want to take a look at some of the examples, as well as the documentation. You'll also be able to find a small template to get a feel for the library.

Getting Started with Bots

extern crate irc;

use irc::client::server::{IrcServer, Server};
use irc::client::server::utils::Wrapper;

fn main() {
    let irc_server = IrcServer::new("config.json").unwrap();
    let server = Wrapper::new(&irc_server);
    server.identify().unwrap();
    for message in server.iter() {
        // Do message processing.
    }
}

Contributing

Contributions to this library would be immensely appreciated. As this project is public domain, all prospective contributors must sign the Contributor License Agreement, a public domain dedication.