Struct Message 

pub struct Message<PayloadDefinition> { /* private fields */ }

A SOME/IP message consisting of a Header and a payload.

Implementations

impl<PayloadDefinition: PayloadWireFormat> Message<PayloadDefinition>

pub const fn new(header: Header, payload: PayloadDefinition) -> Self

Creates a new message from a header and payload.

pub fn new_sd( request_id: u32, sd_header: &<PayloadDefinition as PayloadWireFormat>::SdHeader, ) -> Result<Self, Error>

Creates a new SOME/IP-SD message from a request ID and SD header.

Errors

Returns the error from Encode::encoded_size on the SD header. No in-tree SdHeader can fail this – sd::Header::encoded_size is unconditionally Ok – but PayloadWireFormat is public, and a downstream implementation may.

pub const fn header(&self) -> &Header

Returns a reference to the message header.

pub const fn is_sd(&self) -> bool

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

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

Sets the request ID in the header.

pub fn sd_header( &self, ) -> Option<&<PayloadDefinition as PayloadWireFormat>::SdHeader>

Returns the SD header if this is an SD message, or None otherwise.

pub const fn payload(&self) -> &PayloadDefinition

Returns a reference to the payload.

pub const fn payload_mut(&mut self) -> &mut PayloadDefinition

Returns a mutable reference to the payload.

Trait Implementations

impl<PayloadDefinition: Clone> Clone for Message<PayloadDefinition>

fn clone(&self) -> Message<PayloadDefinition>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<PayloadDefinition: Debug> Debug for Message<PayloadDefinition>

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

Formats the value using the given formatter.

impl<PayloadDefinition: PayloadWireFormat> Encode for Message<PayloadDefinition>

type Error = Error

Per-implementation error; constructible from an I/O embedded_io::ErrorKind so the fixed-width write_* leaf helpers lift through ?.

fn encoded_size(&self) -> Result<usize, Self::Error>

Exact number of bytes encode will write.

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

Serialize into writer; return the number of bytes written.

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

Encode into a fixed slice, reporting needed/available (InsufficientBuffer) instead of a bare embedded_io::ErrorKind::WriteZero when the slice is too small, and hiding the &mut &mut [u8] cursor re-borrow every fixed-buffer call site otherwise writes by hand.

impl<PayloadDefinition: Eq> Eq for Message<PayloadDefinition>

impl<PayloadDefinition: PartialEq> PartialEq for Message<PayloadDefinition>

fn eq(&self, other: &Message<PayloadDefinition>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<PayloadDefinition: PartialEq> StructuralPartialEq for Message<PayloadDefinition>