Struct TpBuf 

pub struct TpBuf { /* private fields */ }

Buffer to reconstruct one SOMEIP TP packet stream without checks that the message id & request id are the same for all packets (this has to be done by the caller).

This buffer only reconstructs one TP stream and assumes that the user only sends data with matching “SOMEIP message id” and matching “SOMEIP request id” as well as matching sender to the buffer.

In case you want something that also automatically reconstructs multiple TP streams and can handles multiple TP stream with differing request ids and message id’s gracefully use crate::TpPool instead.

Example

use someip_parse::TpBuf;
use someip_parse::SomeipMsgSlice;

// setup the buffer
// (replace default if you have knowledge about the upper package sizes)
let mut buf = TpBuf::new(Default::default());

// feed the packets to the buffer
let pkt1_slice = SomeipMsgSlice::from_slice(&pkt1_bytes)?;
assert!(pkt1_slice.is_tp()); // only tp packets are allowed
buf.consume_tp(pkt1_slice.clone())?;

// incomplete packets will fail to finalize
assert_eq!(None, buf.try_finalize());

let pkt2_slice = SomeipMsgSlice::from_slice(&pkt2_bytes)?;
assert!(pkt2_slice.is_tp());

// user of the TpBuf have to ensure the "message id"
// and "request id" are the same for all packets
assert_eq!(pkt1_slice.message_id(), pkt2_slice.message_id());
assert_eq!(pkt1_slice.request_id(), pkt2_slice.request_id());

buf.consume_tp(pkt2_slice.clone())?;

// once the packet is completed you can access the resulting packet
// via "try_finalize"
let reassembled = buf.try_finalize().unwrap();

// the re-assembled packet will be provided as a non TP SOMEIP slice
assert_eq!(false, reassembled.is_tp());
assert_eq!(reassembled.message_id(), pkt1_slice.message_id());
println!("Reconstructed payload: {:?}", reassembled.payload());

// finally you can clear the buffer to re-use the
// memory for a new stream
buf.clear();

Implementations

impl TpBuf

pub fn new(config: TpBufConfig) -> TpBuf

pub fn clear(&mut self)

Reset buffer to starting state.

pub fn consume_tp( &mut self, someip_slice: SomeipMsgSlice<'_>, ) -> Result<(), TpReassembleError>

Consume a TP SOMEIP slice (caller must ensure that someip_slice.is_tp() is true).

pub fn is_complete(&self) -> bool

pub fn try_finalize(&mut self) -> Option<SomeipMsgSlice<'_>>

Try finalizing the reconstructed TP packet and return a reference to it if the stream reconstruction was completed.

Trait Implementations

impl Clone for TpBuf

fn clone(&self) -> TpBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TpBuf

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

Formats the value using the given formatter.

impl Hash for TpBuf

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 Ord for TpBuf

fn cmp(&self, other: &TpBuf) -> 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,

Restrict a value to a certain interval.

impl PartialEq for TpBuf

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

fn partial_cmp(&self, other: &TpBuf) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for TpBuf

impl StructuralPartialEq for TpBuf