Thelie/irc-stream
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update 'src/lib.rs'

Browse source 
Doc comments are hard…
This commit is contained in:
Thelie 2021-05-05 20:54:14 +02:00
parent c778365f4c
commit cbadc86144
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/lib.rs
View file

@ -15,14 +15,15 @@
* along with irc-stream. If not, see <https://www.gnu.org/licenses/>. * 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 mod error;
pub use self::error::*; pub use self::error::*;
use std::io::{Read, Write}; use std::io::{Read, Write};
use irc_proto::message::Message; 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; /// A trait that mirrors std::io::Read;
/// It requires the `read()` method that returns an IRC Message. /// It requires the `read()` method that returns an IRC Message.
/// The function may or may not block. /// The function may or may not block.