Improved documentation on IrcTransport.

This commit is contained in:
Aaron Weiss 2017-08-15 14:43:30 -04:00
parent e220e90c58
commit 99347f536c
No known key found for this signature in database
GPG key ID: 0237035D9BF03AE2

View file

@ -1,4 +1,5 @@
//! An IRC transport that wraps an IRC-framed stream to provide automatic PING replies.
//! An IRC transport that wraps an IRC-framed stream to provide a number of features including
//! automatic PING replies, automatic sending of PINGs, and message rate-limiting.
use std::sync::{Arc, RwLock, RwLockReadGuard};
use std::time::{Duration, Instant};
@ -13,7 +14,7 @@ use error;
use client::data::Config;
use proto::{Command, IrcCodec, Message};
/// An IRC transport that handles automatically replying to PINGs.
/// An IRC transport that handles core functionality.
pub struct IrcTransport<T>
where
T: AsyncRead + AsyncWrite,