Struct someip_messages::Header

pub struct Header {
    pub message_id: MessageId,
    pub length: u32,
    pub request_id: RequestId,
    pub protocol_version: ProtocolVersion,
    pub interface_version: InterfaceVersion,
    pub message_type: MessageType,
    pub return_code: ReturnCode,
}

Represents the header of a SOME/IP message.

Fields

message_id: MessageId

Message id

length: u32

Message length

request_id: RequestId

Request id

protocol_version: ProtocolVersion

Protocol version

interface_version: InterfaceVersion

Interface version

message_type: MessageType

Message type

return_code: ReturnCode

Return code

Implementations

impl Header

pub fn from_slice(input: &[u8]) -> Result<Header, Error>

Parse a header from a byte slice.

pub fn from_reader<R: Read>(reader: &mut R) -> Result<Header, Error>

Parse a header from a Read

impl Header

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

Serializes the header into a byte array.

pub fn to_writer<W: Write>(&self, writer: W) -> Result<usize, Error>

Serialize the header into a writer.

impl Header

pub fn new( message_id: MessageId, length: u32, request_id: RequestId, protocol_version: ProtocolVersion, interface_version: InterfaceVersion, message_type: MessageType, return_code: ReturnCode ) -> Self

Creates a new header with the given message id, length, request id, protocol version, interface version, message type and return code.

pub fn message_id(&self) -> &MessageId

Get message id

pub fn length(&self) -> u32

Raw length field

pub fn message_len(&self) -> usize

The length of the message associated with the header

pub fn payload_len(&self) -> usize

The length of the payload associated with the header

pub fn request_id(&self) -> &RequestId

Get request id

pub fn client_id(&self) -> ClientId

Get client id

pub fn session_id(&self) -> SessionId

Get session id

pub fn protocol_version(&self) -> ProtocolVersion

Get protocol version

pub fn interface_version(&self) -> InterfaceVersion

Get interface version

pub fn message_type(&self) -> MessageType

Get message type

pub fn return_code(&self) -> ReturnCode

Get return code

pub fn is_sd(&self) -> bool

Returns true if the header indicates a SD message

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Length for Header

Provides the fixed length of a Header

const LENGTH: usize = 16usize

Fixed length

impl PartialEq<Header> for Header

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Header

impl StructuralEq for Header

impl StructuralPartialEq for Header