Struct Packet 

pub struct Packet<T: AsRef<[u8]>> { /* private fields */ }

A read/write wrapper around a Some/IP packet buffer.

Implementations

impl<T: AsRef<[u8]>> Packet<T>

pub const fn new_unchecked(buffer: T) -> Packet<T>

Creates a new unchecked Packet.

Arguments

• buffer - A buffer containing the packet data.

Returns

• Packet - A new Packet instance.

pub fn new_checked(buffer: T) -> Result<Packet<T>>

Creates a new checked Packet.

Arguments

• buffer - A buffer containing the packet data.

Returns

• Result<Packet> - A new Packet instance if the buffer is valid.

pub fn check_len(&self) -> Result<()>

Checks the length of the packet.

Returns

• Result<()> - Ok if the length is valid, otherwise an error.

pub fn into_inner(self) -> T

Returns the inner buffer.

Returns

• T - The inner buffer.

pub fn as_slice(&self) -> &[u8]

Returns a reference to the inner buffer.

Returns

• &[u8] - A reference to the buffer.

pub fn message_id(&self) -> MessageId

Returns the Message ID

Returns

• MessageId - The Message ID of the packet

pub fn payload_length(&self) -> usize

Returns the Payload Length

Returns

• usize - The Payload Length of the packet

pub fn request_id(&self) -> RequestId

Returns the Request ID

Returns

• u32 - The Request ID of the packet

pub fn protocol_version(&self) -> u8

Returns the Protocol Version

Returns

• u8 - The Protocol Version of the packet

pub fn interface_version(&self) -> u8

Returns the Interface Version

Returns

• u8 - The Interface Version of the packet

pub fn message_type(&self) -> u8

Returns the Message Type (raw u8)

Returns

• u8 - The raw message type byte from the packet

pub fn return_code(&self) -> u8

Returns the Return Code (raw u8)

Returns

• u8 - The raw return code byte from the packet

pub fn payload_data_range(&self) -> Range<usize>

Returns the range of the payload data

Returns

• Range<usize> - The range of the payload data.

pub fn payload_data_length(&self) -> usize

Returns the length of the payload data.

Returns

• usize - The length of the payload data.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

pub fn set_message_id(&mut self, message_id: MessageId)

Sets the Message ID

Arguments

• message_id - The new Message ID to set

pub fn set_payload_length(&mut self, length: u32)

Sets the Payload Length

Arguments

• length - The new Payload Length to set

pub fn set_request_id(&mut self, request_id: RequestId)

Sets the Request ID

Arguments

• request_id - The new Request ID to set

pub fn set_protocol_version(&mut self, version: u8)

Sets the Protocol Version

Arguments

• version - The new Protocol Version to set

pub fn set_interface_version(&mut self, version: u8)

Sets the Interface Version

Arguments

• version - The new Interface Version to set

pub fn set_message_type(&mut self, message_type: u8)

Sets the Message Type (raw u8)

Arguments

• message_type - The new message type byte to set

pub fn set_return_code(&mut self, return_code: u8)

Sets the Return Code (raw u8)

Arguments

• return_code - The new return code byte to set

impl<'a, T: AsRef<[u8]> + ?Sized> Packet<&'a T>

pub fn payload_data(&self) -> &'a [u8]

Returns a reference to the payload data,

Returns

• &'a [u8] - A reference to the payload data.

pub fn entire_message(&self) -> &'a [u8]

Returns a reference to the entire message.

Returns

• &'a [u8] - A reference to the entire message.

impl<'a, T: AsRef<[u8]> + AsMut<[u8]> + ?Sized> Packet<&'a mut T>

pub fn payload_data_mut(&mut self) -> &mut [u8]

Returns a mutable reference to the payload data,

Returns

• &'a mut [u8] - A mutable reference to the payload data.

pub fn entire_message_mut(&mut self) -> &mut [u8]

Returns a mutable reference to the entire message.

Returns

• &'a mut [u8] - A mutable reference to the entire message.

Trait Implementations

impl<T: Clone + AsRef<[u8]>> Clone for Packet<T>

fn clone(&self) -> Packet<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + AsRef<[u8]>> Debug for Packet<T>

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

Formats the value using the given formatter.

impl<'a, T: AsRef<[u8]> + ?Sized> Display for Packet<&'a T>

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

Formats the packet as a string

Arguments

• f - The formatter

Returns

• fmt::Result - The result of the formatting

impl<T: PartialEq + AsRef<[u8]>> PartialEq for Packet<T>

fn eq(&self, other: &Packet<T>) -> 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<T: Eq + AsRef<[u8]>> Eq for Packet<T>

impl<T: AsRef<[u8]>> StructuralPartialEq for Packet<T>