Struct TryPeekError

pub struct TryPeekError { /* private fields */ }

An error that occurs when trying to peek at data beyond the buffer’s available bytes.

This error indicates that a peek operation failed because the buffer does not contain enough bytes at the current position. Peek operations never modify the buffer position, so this error leaves the buffer in its original state.

Implementations

impl TryPeekError

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

Creates a new TryPeekError with the requested and available bytes.

Panics

• In debug builds, panics if requested <= available (this would not be an error condition).
• The requested value must be a non-zero.

pub const fn requested(&self) -> usize

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.

pub const fn shortage(&self) -> usize

Returns the number of additional bytes needed for the operation to succeed.

This is equivalent to requested() - available().

Trait Implementations

impl Clone for TryPeekError

fn clone(&self) -> TryPeekError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TryPeekError

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

Formats the value using the given formatter.

impl Display for TryPeekError

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

Formats the value using the given formatter.

impl Error for TryPeekError

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<TryPeekError> for Error

fn from(e: TryPeekError) -> Self

Converts to this type from the input type.

impl From<TryPeekError> for TryReadError

fn from(e: TryPeekError) -> Self

Converts to this type from the input type.

impl PartialEq for TryPeekError

fn eq(&self, other: &TryPeekError) -> 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 TryPeekError

impl Eq for TryPeekError

impl StructuralPartialEq for TryPeekError