Update 'src/lib.rs'
Doc comments are hard…
This commit is contained in:
parent
c778365f4c
commit
cbadc86144
1 changed files with 3 additions and 2 deletions
|
@ -15,14 +15,15 @@
|
|||
* along with irc-stream. If not, see <https://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
//! This crate provides the `IrcRead` and `IrcWrite` traits and
|
||||
//! the IrcStream struct that implements them.
|
||||
|
||||
pub mod error;
|
||||
|
||||
pub use self::error::*;
|
||||
use std::io::{Read, Write};
|
||||
use irc_proto::message::Message;
|
||||
|
||||
//! This crate provides the `IrcRead` and `IrcWrite` traits and
|
||||
//! the IrcStream struct that implements them.
|
||||
/// A trait that mirrors std::io::Read;
|
||||
/// It requires the `read()` method that returns an IRC Message.
|
||||
/// The function may or may not block.
|
||||
|
|
Loading…
Reference in a new issue