Skip to content

Commit

Permalink
docs(BufferTooSmall): updated docs for BufferTooSmall error
Browse files Browse the repository at this point in the history
Signed-off-by: Jad K. Haddad <jadkhaddad@gmail.com>
  • Loading branch information
JadKHaddad committed Nov 4, 2024
1 parent d80d6c6 commit 9f2e841
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion src/codec/bincode.rs
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ where
/// An error that can occur when encoding a bincode data structure into a sequence of bytes with a payload length prefix.
#[derive(Debug)]
pub enum BincodeEncodeError {
/// The input buffer is too small to fit the encoded line.
/// The input buffer is too small to fit the encoded item.
BufferTooSmall,
/// A Bincode error occurred.
Encode(EncodeError),
Expand Down
2 changes: 1 addition & 1 deletion src/codec/bytes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ impl<'buf> Decoder<'buf> for BytesCodec {
#[derive(Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum BytesEncodeError {
/// The input buffer is too small.
/// The input buffer is too small to fit the sequence of bytes.
BufferTooSmall,
}

Expand Down
2 changes: 1 addition & 1 deletion src/codec/length.rs
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ impl<'buf> Decoder<'buf> for LengthCodec {
#[derive(Debug)]
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
pub enum LengthEncodeError {
/// The input buffer is too small to fit the encoded line.
/// The input buffer is too small to fit the encoded sequence of bytes.
BufferTooSmall,
/// Payload length is zero.
ZeroPayloadLength,
Expand Down

0 comments on commit 9f2e841

Please sign in to comment.