1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Low-level futures based IRC client library for Rust
//!
//! Tihs library is an implementation of the IRCv3 protocol which uses futures
//! to provide asynchronous processing of incoming and outgoing messages between
//! the client and the server.
//!
//! This library makes extensive use of tokio and futures to provide
//! asynchronous handling of IRC via the `Future`, `Stream`, and `Sink` traits.
//! This allows for the usage of combinators on the stream of incoming messages
//! to allow for easy processing of messages.
//!
//! The abstraction provided by this library is currently very minimal.
//! It currently handles connecting to a remote IRC server either through
//! unencypted sockets or TLS encrypted sockets. It internally handles the
//! parsing of IRC messages and has several helper functions to build IRC
//! messages to be sent to the server. It also handles responding to PING
//! requests from the server and will timeout the connection if no PINGs are
//! received after a certain duration (currently 10 minutes).
//!
//! The main type in this library is the `Cient` struct, which provides the
//! ability to connect to a remote host. The various connection methods on this
//! type return a future, that when complete, provides a stream of IRC messages
//! that can also be written to.  It is possible to call the `split` function
//! on this stream to get a `Stream` or incoming IRC messages and `Sink` for
//! for sending messages to the server.
//!

// TODO: **REALLY** improve the quality of the documentation in this library.
// it's really bad. I'm not very good at writing it.

#![deny(missing_docs)]

#[macro_use]
extern crate futures;
#[macro_use]
extern crate error_chain;
extern crate tokio_core;
extern crate tokio_io;
extern crate bytes;
extern crate pircolate;

#[cfg(feature = "tls")]
extern crate tokio_tls;
#[cfg(feature = "tls")]
extern crate native_tls;

mod codec;
pub mod error;
pub mod client;

pub use client::{Client, ClientConnectFuture};
#[cfg(feature = "tls")]
pub use client::ClientConnectTlsFuture;
pub use error::Error;