Struct TpBufConfig 

pub struct TpBufConfig {
    pub tp_buffer_start_payload_alloc_len: usize,
    /* private fields */
}

Configuration of a TP buffers maximum allowed size and initial allocated buffer size.

Fields

tp_buffer_start_payload_alloc_len: usize

Number of bytes that should be allocated to store payload when a new TpBuf gets created.

Implementations

impl TpBufConfig

pub const MAX_TP_PAYLOAD_LEN: u32 = 4_294_967_279u32

Maximum representable payload len in a TP packet.

This is determined by the maximum value the length field in the SOMEIP header can take - 8 bytes

pub fn tp_max_payload_len(&self) -> u32

Maximum allowed payload length (in bytes) of the final reconstructed packet.

pub fn new( tp_buffer_start_payload_alloc_len: usize, tp_max_payload_len: u32, ) -> Result<TpBufConfig, TpBufConfigError>

Creates a new config with the given initial allocated and maximum allowed payload size.

Example

As long as you don’t set the max_payload_len to more then TpBufConfig::MAX_TP_PAYLOAD_LEN (0xFFFFFFFF - 16):

use someip_parse::TpBufConfig;

let config = TpBufConfig::new(
    // start alloc size
    1024,
    // maximum allowed size
    // (if you have knowledge about the maximum message size,
    // insert that here and above)
    TpBufConfig::MAX_TP_PAYLOAD_LEN
).unwrap();

construction will only fail if you set an upper lenght greater then TpBufConfig::MAX_TP_PAYLOAD_LEN:

use someip_parse::{TpBufConfig, err::TpBufConfigError::*};

assert_eq!(
    TpBufConfig::new(1024, TpBufConfig::MAX_TP_PAYLOAD_LEN + 1),
    Err(MaxPayloadLenTooBig{
        allowed_max: TpBufConfig::MAX_TP_PAYLOAD_LEN,
        actual: TpBufConfig::MAX_TP_PAYLOAD_LEN + 1,
    })
);

Trait Implementations

impl Clone for TpBufConfig

fn clone(&self) -> TpBufConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TpBufConfig

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

Formats the value using the given formatter.

impl Default for TpBufConfig

fn default() -> Self

Returns the “default value” for a type.

impl Hash for TpBufConfig

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 TpBufConfig

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

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

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

impl StructuralPartialEq for TpBufConfig