Enum packet::MaybeParsed

pub enum MaybeParsed<C, I> {
    Complete(C),
    Incomplete(I),
}

A type that encapsulates the result of a complete or incomplete parsing operation.

The type parameters C and I are the types for a “complete” and “incomplete” parsing result, respectively.

Variants

Complete(C)

Incomplete(I)

Implementations

impl<T> MaybeParsed<T, T>

pub fn new_with_min_len(bytes: T, min_len: usize) -> Self

where T: ByteSlice,

Creates a MaybeParsed instance with bytes observing a minimum length min_len.

Returns MaybeParsed::Complete if bytes is at least min_len long, otherwise returns MaybeParsed::Incomplete. In both cases, bytes is moved into one of the two MaybeParsed variants.

pub fn into_inner(self) -> T

Consumes this MaybeParsed and returns its contained value if both the Complete and Incomplete variants contain the same type.

impl<C, I> MaybeParsed<C, I>

pub fn take_from_buffer_with<BV: BufferView<I>, F>( buf: &mut BV, n: usize, map: F, ) -> Self

where F: FnOnce(I) -> C, I: ByteSlice,

Creates a MaybeParsed instance taking n bytes from the front of buf and mapping with map.

If buf contains at least n bytes, then n bytes are consumed from the beginning of buf, those n bytes are passed to map, and the result is returned as MaybeParsed::Complete. Otherwise, all bytes are consumed from buf and returned as MaybeParsed::Incomplete.

pub fn map<M, F>(self, f: F) -> MaybeParsed<M, I>

where F: FnOnce(C) -> M,

Maps a MaybeParsed::Complete variant to another type.

If self is MaybeParsed::Incomplete, it is left as-is.

pub fn map_incomplete<M, F>(self, f: F) -> MaybeParsed<C, M>

where F: FnOnce(I) -> M,

Maps a MaybeParsed::Incomplete variant to another type.

If self is MaybeParsed::Complete, it is left as-is.

pub fn as_ref(&self) -> MaybeParsed<&C, &I>

Converts from &MaybeParsed<C, I> to MaybeParsed<&C, &I>.

pub fn complete(self) -> Result<C, I>

Transforms self into a Result, mapping the Complete variant into Ok.

pub fn incomplete(self) -> Result<I, C>

Transforms self into a Result, mapping the Incomplete variant into Ok.

pub fn ok_or_else<F, E>(self, f: F) -> Result<C, E>

where F: FnOnce(I) -> E,

Transforms this MaybeIncomplete into a Result where the Complete variant becomes Ok and the Incomplete variant is passed through f and mapped to Err.

impl<C, I> MaybeParsed<C, I>

where C: Deref<Target = [u8]>, I: Deref<Target = [u8]>,

pub fn len(&self) -> usize

Returns the length in bytes of the contained data.

pub fn is_empty(&self) -> bool

Returns whether the contained data is empty - zero bytes long.

Trait Implementations

impl<C: Clone, I: Clone> Clone for MaybeParsed<C, I>

fn clone(&self) -> MaybeParsed<C, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, I: Debug> Debug for MaybeParsed<C, I>

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

Formats the value using the given formatter.

impl<C: PartialEq, I: PartialEq> PartialEq for MaybeParsed<C, I>

fn eq(&self, other: &MaybeParsed<C, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<C: Copy, I: Copy> Copy for MaybeParsed<C, I>

impl<C: Eq, I: Eq> Eq for MaybeParsed<C, I>

impl<C, I> StructuralPartialEq for MaybeParsed<C, I>