Enum BoxedHeader

pub enum BoxedHeader<O, B> {
    Repr(Box<O>),
    Raw(B),
}

A header which is either owned or read from a buffer, which heap-allocates if the data is owned.

Generally, use of boxed Repr values reduces output struct sizes when parsing full packets and is preferred when compiling with the alloc feature. See InlineHeader if stack allocation is needed.

Variants

Repr(Box<O>)

Owned, in-memory representation of a header.

Raw(B)

Packed representation of a header, read from an existing buffer.

Implementations

impl<O, B> BoxedHeader<O, B>

pub fn repr(&self) -> Option<&O>

Return a reference to this packet’s contents if they are owned.

pub fn repr_mut(&mut self) -> Option<&mut O>

Return a mutable reference to this packet’s contents if they are owned.

pub fn raw(&self) -> Option<&B>

Return a reference to this packet’s contents if they are borrowed.

pub fn raw_mut(&mut self) -> Option<&mut B>

Return a mutable reference to this packet’s contents if they are borrowed.

Trait Implementations

impl<O: Clone, B: Clone> Clone for BoxedHeader<O, B>

fn clone(&self) -> BoxedHeader<O, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<O: Debug, B: Debug> Debug for BoxedHeader<O, B>

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

Formats the value using the given formatter.

impl<O: Emit, B: Emit> Emit for BoxedHeader<O, B>

fn emit_raw<V: ByteSliceMut>(&self, buf: V) -> usize

Writes this packet’s contents into a target buffer without performing length checks.

fn needs_emit(&self) -> bool

Returns whether this packet needs a full re-emit, and has not been simply modified in-place.

fn emit<V: ByteSliceMut>(&self, buf: V) -> ParseResult<usize>

Writes this packet’s contents into a target buffer.

fn emit_prefix<V: SplitByteSliceMut>(&self, buf: V) -> ParseResult<V>

Writes this packet’s contents into the start of a target buffer.

fn emit_suffix<V: SplitByteSliceMut>(&self, buf: V) -> ParseResult<V>

Writes this packet’s contents at the end of a target buffer.

fn to_vec(&self) -> Vec<u8>

Writes this packet’s contents into a newly allocated Vec of length Header::packet_length.

fn emit_uninit(&self, buf: &mut [MaybeUninit<u8>]) -> ParseResult<usize>

where Self: EmitDoesNotRelyOnBufContents,

Writes this packet’s contents into uninitialised memory.

fn emit_vec(&self) -> Vec<u8>

where Self: EmitDoesNotRelyOnBufContents,

Writes this packet’s contents into a newly allocated Vec of length Header::packet_length, without zero-filling the contents.

impl<'a, T: HasView<V>, V> From<&'a BoxedHeader<T, <T as HasView<V>>::ViewType>> for FieldRef<'a, T, V>

fn from(value: &'a BoxedHeader<T, <T as HasView<V>>::ViewType>) -> Self

Converts to this type from the input type.

impl<B: ByteSlice, T> From<&BoxedHeader<Vec<T>, ObjectSlice<B, T>>> for Vec<T>

where T: FromBytes + IntoBytes + KnownLayout + Immutable + Clone,

fn from(value: &Header<Vec<T>, ObjectSlice<B, T>>) -> Self

Converts to this type from the input type.

impl<B: ByteSlice, T> From<&BoxedHeader<Vec<T>, RawBytes<B>>> for Vec<T>

where T: FromBytes + IntoBytes + KnownLayout + Immutable + Clone,

fn from(value: &Header<Vec<T>, RawBytes<B>>) -> Self

Converts to this type from the input type.

impl<V: ByteSlice> From<&BoxedHeader<Vec<u8>, V>> for Vec<u8>

fn from(value: &VarBytes<V>) -> Self

Converts to this type from the input type.

impl<'a, T: HasView<V>, V> From<&'a mut BoxedHeader<T, <T as HasView<V>>::ViewType>> for FieldMut<'a, T, V>

fn from(value: &'a mut BoxedHeader<T, <T as HasView<V>>::ViewType>) -> Self

Converts to this type from the input type.

impl<O, B> From<BoxedHeader<O, B>> for InlineHeader<O, B>

fn from(value: BoxedHeader<O, B>) -> Self

Converts to this type from the input type.

impl<O, B> From<InlineHeader<O, B>> for BoxedHeader<O, B>

fn from(value: InlineHeader<O, B>) -> Self

Converts to this type from the input type.

impl<O, B> HasRepr for BoxedHeader<O, B>

type ReprType = O

The type containing an equivalent to Self, as an owned struct.

impl<O: HasView<V, ViewType = B>, B, V> HasView<V> for BoxedHeader<O, B>

type ViewType = B

The type containing an equivalent to Self, as a network packet in a buffer B.

impl<O: Hash, B: Hash> Hash for BoxedHeader<O, B>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<O, B> HeaderLen for BoxedHeader<O, B>

where O: HeaderLen, B: HeaderLen,

const MINIMUM_LENGTH: usize = O::MINIMUM_LENGTH

The minimum number of bytes a packet of this kind occupies when serialised.

fn packet_length(&self) -> usize

The number of bytes which this packet would occupy when serialised.

impl<V: SplitByteSlice, B> HeaderParse<V> for BoxedHeader<B::ReprType, B>

where B: NextLayer + HeaderParse<V> + HasRepr + Into<Self>, B::ReprType: NextLayer<Denom = B::Denom, Hint = B::Hint>,

fn parse_choice( from: V, hint: Option<Self::Hint>, ) -> ParseResult<Success<Self, V>>

Parse a view-type from a given buffer, using a hint

fn parse(from: B) -> ParseResult<Success<Self, B>>

Parse a view-type from a given buffer.

impl<O: NextLayer, B> NextLayer for BoxedHeader<O, B>

where B: NextLayer<Denom = O::Denom, Hint = O::Hint>,

type Denom = <O as NextLayer>::Denom

The type of this header’s next-layer hint.

type Hint = <O as NextLayer>::Hint

A type used to help parse the header

fn next_layer_choice(&self, hint: Option<Self::Hint>) -> Option<Self::Denom>

Try to retrieve this header’s next-layer hint, using a provided hint

fn next_layer(&self) -> Option<Self::Denom>

Retrieve this header’s next-layer hint, if possible.

impl<O: PartialEq, B: PartialEq> PartialEq for BoxedHeader<O, B>

fn eq(&self, other: &BoxedHeader<O, B>) -> 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<O: NextLayer + Clone, B: NextLayer<Denom = O::Denom, Hint = O::Hint> + ToOwnedPacket<Target = O>> ToOwnedPacket for BoxedHeader<O, B>

type Target = O

The output type of this conversion.

fn to_owned(&self, hint: Option<Self::Hint>) -> ParseResult<Self::Target>

Converts a borrowed view of a header into an owned version, possibly reparsing to do so with the aid of hint.

impl<O: EmitDoesNotRelyOnBufContents, B: EmitDoesNotRelyOnBufContents> EmitDoesNotRelyOnBufContents for BoxedHeader<O, B>

impl<O: Eq, B: Eq> Eq for BoxedHeader<O, B>

impl<O, B> StructuralPartialEq for BoxedHeader<O, B>