Update 'src/error.rs'

Added doc comments.
This commit is contained in:
Thelie 2021-05-05 19:45:39 +02:00
parent bf53e62f17
commit b23709917e

View file

@ -22,6 +22,10 @@ use std::{
str, str,
}; };
//! Implements IrcStreamError, an error type
//! that wraps all possible error that are thrown by IrcStream.
/// A custom error type that wraps all error that IrcStream will throw.
#[derive(Debug)] #[derive(Debug)]
pub enum IrcStreamError { pub enum IrcStreamError {
Io(io::Error), Io(io::Error),