Struct Header 

pub struct Header { /* private fields */ }

SOME/IP header

Implementations

impl Header

pub const fn message_id(&self) -> MessageId

Returns the message ID (service ID + method ID).

pub const fn length(&self) -> u32

Returns the length field (payload size + 8).

pub const fn request_id(&self) -> u32

Returns the request ID (client ID + session ID).

pub const fn protocol_version(&self) -> u8

Returns the protocol version.

pub const fn interface_version(&self) -> u8

Returns the interface version.

pub const fn message_type(&self) -> MessageTypeField

Returns the message type field.

pub const fn return_code(&self) -> ReturnCode

Returns the return code.

pub const fn upper_header_bytes(&self) -> [u8; 8]

Return the 8-byte “upper header” used by E2E UPPER-HEADER-BITS-TO-SHIFT.

Layout (big-endian): request_id(4) + protocol_version(1) + interface_version(1) + message_type(1) + return_code(1)

Note: request_id is the full 4-byte SOME/IP Request ID field (Client ID [31:16] + Session ID [15:0]), not just the 2-byte Session ID.

pub const fn from_fields( message_id: MessageId, length: u32, request_id: u32, protocol_version: u8, interface_version: u8, message_type: MessageTypeField, return_code: ReturnCode, ) -> Self

Creates a header from raw field values.

Unlike new, the length field is taken directly rather than being computed from a payload size. This is the inverse of the accessor methods and is useful for FFI or any context where the caller already has the raw on-wire field values.

pub const fn new( message_id: MessageId, request_id: u32, protocol_version: u8, interface_version: u8, message_type: MessageTypeField, return_code: ReturnCode, payload_len: usize, ) -> Self

Creates a new header with the given fields.

Panics

Panics if payload_len exceeds u32::MAX - 8.

pub const fn new_sd(request_id: u32, sd_header_size: usize) -> Self

Creates a new SOME/IP-SD header with standard SD field values.

Panics

Panics if sd_header_size exceeds u32::MAX - 8.

pub const fn new_event( service_id: u16, event_id: u16, request_id: u32, protocol_version: u8, interface_version: u8, payload_len: usize, ) -> Self

Creates a new header for a SOME/IP event notification.

Panics

Panics if payload_len exceeds u32::MAX - 8.

pub const fn is_sd(&self) -> bool

Returns true if this is a SOME/IP-SD message.

pub const fn payload_size(&self) -> usize

Returns the payload size in bytes (length - 8).

pub const fn set_request_id(&mut self, request_id: u32)

Sets the request ID field.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate 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 PartialEq for Header

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

fn required_size(&self) -> usize

Returns the number of bytes required to serialize this value.

fn encode<T: Write>(&self, writer: &mut T) -> Result<usize, Error>

Serialize a value to a byte stream. Returns the number of bytes written.

fn encode_to_slice(&self, buf: &mut [u8]) -> Result<usize, Error>

Encode into a byte slice, returning the number of bytes written.

impl Eq for Header

impl StructuralPartialEq for Header