Struct someip_parse::SomeipMsgSlice

pub struct SomeipMsgSlice<'a> { /* private fields */ }

A slice containing an some ip header & payload of that message.

Implementations

impl<'a> SomeipMsgSlice<'a>

pub fn from_slice( slice: &'a [u8] ) -> Result<SomeipMsgSlice<'_>, SomeipSliceError>

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

Return the slice that contains the someip header

pub fn message_id(&self) -> u32

Returns the message id of the message.

pub fn service_id(&self) -> u16

Returns the service id (first 16 bits of the message id)

pub fn is_event(&self) -> bool

Returns true if the event or notification bit in the message id is set

pub fn event_or_method_id(&self) -> u16

Return the event id or method id. This number includes the “event bit”.

pub fn event_id(&self) -> Option<u16>

Return the event id. None if event bit is not set.

pub fn method_id(&self) -> Option<u16>

Return the method id. None if event bit is set.

pub fn is_someip_sd(&self) -> bool

Returns true if the message has the message id of a some ip service discovery message.

pub fn length(&self) -> u32

Returns the length contained in the header. WARNING: the length paritally contains the header and partially the payload, use the payload() method instead if you want to access the payload slice).

pub fn request_id(&self) -> u32

Returns the request id of the message.

pub fn protocol_version(&self) -> u8

Return the value of the protocol version field of the message (must match SOMEIP_PROTOCOL_VERSION, unless something dark and unsafe is beeing done).

pub fn interface_version(&self) -> u8

Returns the interface version field of the message.

pub fn message_type(&self) -> MessageType

Return the message type (does not contain the tp flag, use the message_type_tp method for checking if this is a tp message).

pub fn message_type_raw(&self) -> u8

Returns the raw message type value (contains the tp flag).

pub fn is_tp(&self) -> bool

Returns true if the tp flag in the message type is set (Transporting large SOME/IP messages of UDP [SOME/IP-TP])

pub fn return_code(&self) -> u8

Returns the return code of the message.

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

Return a slice to the payload of the someip header.

If the there is tp header present the memory after the tp header is returned.

pub fn tp_header(&self) -> Option<TpHeader>

Returns the tp header if there should be one present.

pub fn to_header(&self) -> SomeipHeader

Decode all the fields and copy the results to a SomeIpHeader struct

Trait Implementations

impl<'a> Clone for SomeipMsgSlice<'a>

fn clone(&self) -> SomeipMsgSlice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SomeipMsgSlice<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for SomeipMsgSlice<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for SomeipMsgSlice<'a>

fn cmp(&self, other: &SomeipMsgSlice<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for SomeipMsgSlice<'a>

fn eq(&self, other: &SomeipMsgSlice<'a>) -> 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<'a> PartialOrd for SomeipMsgSlice<'a>

fn partial_cmp(&self, other: &SomeipMsgSlice<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Eq for SomeipMsgSlice<'a>

impl<'a> StructuralEq for SomeipMsgSlice<'a>

impl<'a> StructuralPartialEq for SomeipMsgSlice<'a>