Struct MacsecHeader

pub struct MacsecHeader {
    pub ptype: MacsecPType,
    pub endstation_id: bool,
    pub scb: bool,
    pub an: MacsecAn,
    pub short_len: MacsecShortLen,
    pub packet_nr: u32,
    pub sci: Option<u64>,
}

MACsec SecTag header (present at the start of a packet capsuled with MACsec).

Fields

ptype: MacsecPType

Payload type (contains encryption, modification flag as well as the next ether type if available)

endstation_id: bool

End station identifier (TCI.ES flag).

scb: bool

Ethernet passive optical network broadcast flag.

an: MacsecAn

Association number (identifies SAs).

short_len: MacsecShortLen

Short length with reserved bits.

packet_nr: u32

Packet number.

sci: Option<u64>

Secure channel identifier.

Implementations

impl MacsecHeader

pub const MIN_LEN: usize = 6usize

Minimum length of an MacSec header in bytes/octets.

pub const MAX_LEN: usize = 16usize

Maximum length of an MacSec header (including ether type of payload) in bytes/octets.

pub fn encrypted(&self) -> bool

Encryption flag, which indicates whether the user data is encrypted (true = encrypted, TCI.E flag).

pub fn userdata_changed(&self) -> bool

Flag for change text, set if the user data is modified.

pub fn next_ether_type(&self) -> Option<EtherType>

Ether type of the data following the mac sec tag.

pub fn from_slice(slice: &[u8]) -> Result<MacsecHeader, HeaderSliceError>

Try creating a MacsecHeaderSlice from a slice containing the MACsec header & next ether type.

pub fn to_bytes(&self) -> ArrayVec<u8, { MacsecHeader::MAX_LEN }>

Serialize the mac sec header.

pub fn read<T: Read + Sized>( reader: &mut T, ) -> Result<MacsecHeader, HeaderReadError>

Available on crate feature std only.

Try reading a MACsec header from the position of the reader.

pub fn write<T: Write + Sized>(&self, writer: &mut T) -> Result<(), Error>

Available on crate feature std only.

Writes a given MACsec header to the current position (SecTag & next ether type if available).

pub fn header_len(&self) -> usize

Length of the MACsec header (SecTag + next ether type if available).

pub fn expected_payload_len(&self) -> Option<usize>

Returns the required length of the payload (data after header + next_ether_type if present) if possible.

If the length cannot be determined (short_len is zero or less then 2 when ptype Unmodified) None is returned.

pub fn set_payload_len(&mut self, payload_len: usize)

Set the short_len field based on the given payload byte len (payload len excluding the ether_type if ptype Unmodified) based on the current ptype.

Trait Implementations

impl Clone for MacsecHeader

fn clone(&self) -> MacsecHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MacsecHeader

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

Formats the value using the given formatter.

impl PartialEq for MacsecHeader

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

impl StructuralPartialEq for MacsecHeader