Struct DoipHeader 

pub struct DoipHeader {
    pub protocol_version: ProtocolVersion,
    pub inverse_protocol_version: u8,
    pub payload_type: PayloadType,
    pub payload_length: u32,
}

The definitive fields of a DoIP frame.

The definition of a DoIP frame is found in the DoipHeader, this contains each key field which a parser uses to identify the bytes which pertain to a DoIP frame.

Fields

protocol_version: ProtocolVersion

protocol_version acts a pair with the inverse_protocol_version to create a validation check to ensure the packet is constructed correctly. There are specific versions available within the DoipVersion enum.

inverse_protocol_version: u8

Calculated using bitwise inversion, the inverse_protocol_version acts as a validation technique for validating the packet.

payload_type: PayloadType

The type of payload alongside the header, this defines what is contained within the message, and directs the parser to accurately identify fields.

A list of valid Payload Types are available in the PayloadType enum.

payload_length: u32

The payload_length is automatically calulated on the construction of a DoipHeader and is taken from the payload the header was initiated with.

This tells the parser how many bytes to expect after the header.

Trait Implementations

impl Clone for DoipHeader

fn clone(&self) -> DoipHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DoipHeader

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

Formats the value using the given formatter.

impl Default for DoipHeader

fn default() -> Self

Constructs a default DoipHeader with:

• Protocol version set to DefaultValue
• Inverse protocol version calculated automatically
• Payload type set to AliveCheckRequest
• Payload length initialized to 0

impl From<DoipHeader> for [u8; 8]

fn from(value: DoipHeader) -> Self

Converts to this type from the input type.

impl PartialEq for DoipHeader

fn eq(&self, other: &DoipHeader) -> 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 TryFrom<[u8; 8]> for DoipHeader

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: [u8; 8]) -> Result<Self>

Performs the conversion.

impl StructuralPartialEq for DoipHeader