From 99347f536c869e3d652fa1e5db6120905e37d379 Mon Sep 17 00:00:00 2001 From: Aaron Weiss Date: Tue, 15 Aug 2017 14:43:30 -0400 Subject: [PATCH] Improved documentation on IrcTransport. --- src/client/transport.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/client/transport.rs b/src/client/transport.rs index bf2906e..b3bd727 100644 --- a/src/client/transport.rs +++ b/src/client/transport.rs @@ -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 where T: AsyncRead + AsyncWrite,