Skip to content

Commit

Permalink
docs: update fn doc
Browse files Browse the repository at this point in the history
  • Loading branch information
josecelano committed Sep 25, 2024
1 parent 9db8b1e commit b3c0c8b
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions src/parsers/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,18 @@ impl<R: Read, W: Write> BencodeParser<R, W> {
}
}

/// todo
/// It parses a bencoded value read from input and writes the corresponding
/// JSON value to the output.
///
/// # Errors
///
///
/// Will return an error if it can't read from the input or write to the
/// output.
///
/// # Panics
///
/// Will panic if ...
#[allow(clippy::single_match)]
/// Will panic if receives a byte that isn't a valid begin or end of a
/// bencoded type: integer, string, list or dictionary.
pub fn parse(&mut self) -> io::Result<()> {
loop {
let byte = match self.byte_reader.read_byte() {
Expand Down

0 comments on commit b3c0c8b

Please sign in to comment.