Struct GSEHeader 

pub struct GSEHeader { /* private fields */ }

GSE Header.

This structure stores the parsed field values from a GSE Header.

Implementations

impl GSEHeader

pub fn from_slice( slice: &[u8], re_used_label: Option<&Label>, ) -> Option<GSEHeader>

Creates a GSE Header by parsing the values in a slice.

On success, the GSE Header is returned.

If the slice is not long enough to fully contain the GSE Header, None is returned. Since GSE Headers are variable-length, whether this function returns None or not can depend on the values at the beginning of the slice, in addition to its length.

Additionally, None is returned if the header corresponds to padding bytes (i.e., if the contents of its fixed fields are all zero).

In order to fully parse a GSE Header, due to the concept of “label re-use”, it is necessary to know the label of a previous GSE Header in the same BBFRAME. This can be provided in the re_used_label parameter. If this parameter is None and a GSE Header with START = 1 and label re-use is found in the slice, then this function fails, returning None.

pub fn start(&self) -> bool

Gives the value of the Start Indicator field.

pub fn end(&self) -> bool

Gives the value of the End Indicator field.

pub fn is_single_fragment(&self) -> bool

Returns true if the GSE Packet is not fragmented.

A GSE Packet is not fragmented if both its Start Indicator and its End Indicator contain true.

pub fn label_type(&self) -> LabelType

Gives the value Label Type Indicator field.

pub fn gse_length(&self) -> u16

Gives the value of the GSE Length field.

pub fn fragment_id(&self) -> Option<u8>

Gives the value of the Fragment ID field, if present.

pub fn total_length(&self) -> Option<u16>

Gives the value of the Total Length field, if present.

pub fn protocol_type(&self) -> Option<u16>

Gives the value of the Protocol Type field, if present.

pub fn label(&self) -> Option<&Label>

Gives the value of the Label field, if present.

pub fn len(&self) -> usize

Gives the length in bytes of the GSE Header.

pub fn is_empty(&self) -> bool

Returns true if the GSE Header has a length of zero bytes.

This always returns false, since a GSE Header never has a length of zero bytes. This function exists because objects that implement a len method should also implement an is_empty method.

Trait Implementations

impl Clone for GSEHeader

fn clone(&self) -> GSEHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GSEHeader

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

Formats the value using the given formatter.

impl Display for GSEHeader

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

Formats the value using the given formatter.

impl Hash for GSEHeader

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 GSEHeader

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

impl StructuralPartialEq for GSEHeader