Enum TryPeekAtError

#[non_exhaustive]
pub enum TryPeekAtError {
    OutOfBounds(OutOfBounds),
    InsufficientData(InsufficientDataAt),
}

An error that occurs when trying to peek at a specific offset in the buffer.

This error is returned when the offset is out of bounds or when there is insufficient data to peek the requested data.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OutOfBounds(OutOfBounds)

An error that occurs when trying to peek at an offset that is out of bounds for the buffer.

InsufficientData(InsufficientDataAt)

An error that occurs when there is not enough data in the buffer to peek the requested data.

Implementations

impl TryPeekAtError

pub const fn out_of_bounds(offset: usize, length: usize) -> Self

Creates a new TryPeekAtError::OutOfBounds error.

pub const fn insufficient_data(available: usize, offset: usize) -> Self

Creates a new TryPeekAtError::InsufficientData error.

Panics

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

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

Creates a new TryPeekAtError::InsufficientData error.

Panics

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

Trait Implementations

impl Clone for TryPeekAtError

fn clone(&self) -> TryPeekAtError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TryPeekAtError

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

Formats the value using the given formatter.

impl Display for TryPeekAtError

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

Formats the value using the given formatter.

impl Error for TryPeekAtError

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<InsufficientDataAt> for TryPeekAtError

fn from(source: InsufficientDataAt) -> Self

Converts to this type from the input type.

impl From<OutOfBounds> for TryPeekAtError

fn from(source: OutOfBounds) -> Self

Converts to this type from the input type.

impl From<TryPeekAtError> for Error

fn from(e: TryPeekAtError) -> Self

Converts to this type from the input type.

impl PartialEq for TryPeekAtError

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

impl StructuralPartialEq for TryPeekAtError