Struct TryPutError 

pub struct TryPutError { /* private fields */ }

An error that occurs when trying to write data to a buffer with insufficient space.

This error indicates that a write operation failed because the buffer does not have enough remaining capacity to hold the data.

This error is particularly useful for Sans-I/O designs as it provides exact information about space requirements, allowing the caller to allocate a larger buffer and retry:

let mut small_buf = [0u8; 4];
let mut writer = &mut small_buf[..];

match writer.try_put_u64_le(0x123456789ABCDEF0) {
    Err(e) => {
        // Caller knows exactly how much space is needed
        assert_eq!(e.requested().get(), 8);
        assert_eq!(e.available(), 4);
    }
    _ => panic!("Expected error"),
}

Implementations

impl TryPutError

pub const fn new(requested: NonZeroUsize, available: usize) -> Self

Creates a new TryPutError with the requested and available bytes.

Panics

• If requested <= available (this would not be an error condition).
• The requested value must be a non-zero.

pub const fn requested(&self) -> NonZeroUsize

Returns the number of bytes requested for the operation.

This is the minimum number of bytes needed for the operation to succeed.

pub const fn available(&self) -> usize

Returns the number of bytes available in the buffer.

This is the actual number of bytes that were available when the operation failed.

Trait Implementations

impl Clone for TryPutError

fn clone(&self) -> TryPutError

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TryPutError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for TryPutError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for TryPutError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<TryPutError> for Error

fn from(e: TryPutError) -> Self

Converts to this type from the input type.

impl PartialEq for TryPutError

fn eq(&self, other: &TryPutError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for TryPutError

impl Eq for TryPutError

impl StructuralPartialEq for TryPutError