Struct someip_parse::TpHeader

pub struct TpHeader {
    pub more_segment: bool,
    /* private fields */
}

Additional header when a packet contains a TP header (transporting large SOME/IP messages).

Fields

more_segment: bool

Flag signaling that more packets should follow

Implementations

impl TpHeader

pub fn new(more_segment: bool) -> TpHeader

Creates a tp header with offset 0 and the given “move_segment” flag.

Example:

use someip_parse::TpHeader;

// create a header with the more_segement flag set
let header = TpHeader::new(true);

assert_eq!(0, header.offset());
assert_eq!(true, header.more_segment);

pub fn with_offset( offset: u32, more_segment: bool ) -> Result<TpHeader, TpOffsetNotMultipleOf16Error>

Creates a tp header with the given offset & “more_segment” flag if the offset is a multiple of 16. Otherwise an TpOffsetNotMultipleOf16 error is returned.

Example:

use someip_parse::{TpHeader, err::TpOffsetNotMultipleOf16Error};

// create a header with offset 32 (multiple of 16) and the more_segement flag set
let header = TpHeader::with_offset(32, true).unwrap();

assert_eq!(32, header.offset());
assert_eq!(true, header.more_segment);

// try to create a header with a bad offset (non multiple of 16)
let error = TpHeader::with_offset(31, false);

assert_eq!(Err(TpOffsetNotMultipleOf16Error{ bad_offset: 31 }), error);

pub fn offset(&self) -> u32

Returns the offset field of the tp header. The offset defines

pub fn set_offset( &mut self, offset: u32 ) -> Result<(), TpOffsetNotMultipleOf16Error>

Sets the field of the header and returns Ok(()) on success. Note: The value must be a multiple of 16.

If the given value is not a multiple of 16, the value is not set and an error err::TpOffsetNotMultipleOf16Error is returned.

pub fn read<T: Read>(reader: &mut T) -> Result<TpHeader, Error>

Read a header from a byte stream.

pub fn read_from_slice(slice: &[u8]) -> Result<TpHeader, LenError>

Reads a tp header from a slice.

pub unsafe fn from_slice_unchecked(slice: &[u8]) -> TpHeader

Read the value from the slice without checking for the minimum length of the slice.

Safety

It is required that the slice has at least the length of TP_HEADER_LENGTH (4 octets/bytes). If this is not the case undefined behavior will occur.

pub fn write<T: Write>(&self, writer: &mut T) -> Result<(), Error>

Writes the header to the given writer.

pub fn write_to_slice( &self, slice: &mut [u8] ) -> Result<(), SliceWriteSpaceError>

Writes the header to a slice.

pub fn to_bytes(&self) -> [u8; 4]

Writes the header to a slice without checking the slice length.

Trait Implementations

impl Clone for TpHeader

fn clone(&self) -> TpHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TpHeader

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

Formats the value using the given formatter.

impl Default for TpHeader

fn default() -> TpHeader

Returns the “default value” for a type.

impl PartialEq for TpHeader

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

impl StructuralEq for TpHeader

impl StructuralPartialEq for TpHeader