Struct ScionPacketHeader 

pub struct ScionPacketHeader {
    pub common: CommonHeader,
    pub address: AddressHeader,
    pub path: DpPath,
}

Represents a SCION packet header

This structure contains all the fields of a SCION packet header, including the common header, address header, and path information.

Fields

common: CommonHeader

The common header of the SCION packet

address: AddressHeader

The address header of the SCION packet

path: DpPath

The path information of the SCION packet

Implementations

impl ScionPacketHeader

pub fn required_size(&self) -> usize

Returns the size required for the wire encoding.

Safety

This size must be correct, it is used to validate buffer sizes in encode. If this size is smaller than the actual encoded size, undefined behavior will occur.

pub fn wire_valid(&self) -> Result<(), InvalidStructureError>

Validates that all fields in the structure are valid for encoding.

Note: This only checks the minimal set of fields required for encoding, do not expect comprehensive validation.

Returns Ok(()) if valid, otherwise a static error reference.

pub unsafe fn encode_unchecked( &self, buf: &mut [u8], payload_size: u16, ) -> usize

Writes the wire encoding into the provided buffer.

Returns the number of bytes written.

SAFETY

1. The buffer must be at least self.required_size() bytes long
2. The structure must be valid for encoding, i.e., self.valid() must return Ok(())

pub fn try_encode( &self, buf: &mut [u8], payload_size: u16, ) -> Result<usize, EncodeError>

Writes the wire encoding into the provided buffer.

Returns the number of bytes written on success, or Err(usize) of the required size if the buffer is too small or the packet.

The buffer must be at least self.required_size() bytes long.

Trait Implementations

impl Arbitrary for ScionPacketHeader

type Parameters = ArbitraryScionPacketHeaderParams

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<ScionPacketHeader>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(params: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for ScionPacketHeader

fn clone(&self) -> ScionPacketHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScionPacketHeader

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

Formats the value using the given formatter.

impl Eq for ScionPacketHeader

impl Hash for ScionPacketHeader

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 PartialEq for ScionPacketHeader

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScionPacketHeader

impl TryFromView for ScionPacketHeader

type ViewType = ScionHeaderView

The type of view that can be converted into this model.

fn try_from_view(view: &Self::ViewType) -> Result<Self, ViewConversionError>

Attempts to parse a model from the provided view, returning an error if the view is invalid.

fn try_from_slice<'buf>( buf: &'buf [u8], ) -> Result<(Self, &'buf [u8]), ViewConversionError>

where <Self as TryFromView>::ViewType: 'buf,

Attempts to parse a model from the provided buffer, returning the model and the remaining buffer on success.