Skip to content

Commit

Permalink
Tiny documentation fix on lz4::block::compress_to_buffer
Browse files Browse the repository at this point in the history
A couple of small fixes on doc comment of `lz4::block::compress_to_buffer`:
* mentioned maximum buffer length
* fixed a typo
  • Loading branch information
kastixx authored Jan 16, 2023
1 parent 418855f commit deb7cf8
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion src/block/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,8 @@ pub fn compress(src: &[u8], mode: Option<CompressionMode>, prepend_size: bool) -
///
/// # Errors
/// Returns std::io::Error with ErrorKind::InvalidInput if the src buffer is too long.
/// Returns std::io::Error with ErrorKind::Other if the compression data does not find in `buffer`.
/// The buffer cannot be larger than `i32::MAX`.
/// Returns std::io::Error with ErrorKind::Other if the compression data does not fit in `buffer`.
pub fn compress_to_buffer(
src: &[u8],
mode: Option<CompressionMode>,
Expand Down

0 comments on commit deb7cf8

Please sign in to comment.