Skip to main content

DataFragSubmessage

Struct DataFragSubmessage 

Source
pub struct DataFragSubmessage {
Show 13 fields pub extra_flags: u16, pub reader_id: EntityId, pub writer_id: EntityId, pub writer_sn: SequenceNumber, pub fragment_starting_num: FragmentNumber, pub fragments_in_submessage: u16, pub fragment_size: u16, pub sample_size: u32, pub serialized_payload: Arc<[u8]>, pub inline_qos_flag: bool, pub hash_key_flag: bool, pub key_flag: bool, pub non_standard_flag: bool,
}
Expand description

DATA_FRAG submessage. Carries a section (fragments) of a sample whose total size is in sample_size.

Flags (Q/H/K/N) are mirrored from the submessage header. The encoder does not currently set these flags; the decoder accepts them on read.

Fields§

§extra_flags: u16

octetsToInlineQos analogue to DATA (§8.3.7.2 speaks of extraFlags+ octetsToInlineQos; this variant carries 0).

§reader_id: EntityId

Reader EntityId (target).

§writer_id: EntityId

Writer EntityId (source).

§writer_sn: SequenceNumber

Sequence number of the sample whose fragments this carries.

§fragment_starting_num: FragmentNumber

First fragment in this submessage (1-based).

§fragments_in_submessage: u16

Number of fragments in this submessage. Writer: always 1.

§fragment_size: u16

Size of a single fragment (the last may be shorter).

§sample_size: u32

Total size of the sample in bytes.

§serialized_payload: Arc<[u8]>

Fragmented payload section. Arc-shared: writer re-sends are just refcount bumps, no copy.

§inline_qos_flag: bool

Q-flag from the submessage header (inline_qos present).

§hash_key_flag: bool

H-flag from the submessage header (hash_key).

§key_flag: bool

K-flag from the submessage header (serialized_payload = key).

§non_standard_flag: bool

N-flag from the submessage header (non-standard payload).

Implementations§

Source§

impl DataFragSubmessage

Source

pub const HEADER_WIRE_SIZE: usize = 32

Minimal body size without payload: extraFlags(2) + octetsToInlineQos(2)

  • readerId(4) + writerId(4) + writerSN(8) + fragmentStartingNum(4)
  • fragmentsInSubmessage(2) + fragmentSize(2) + sampleSize(4) = 32.
Source

pub const OCTETS_TO_INLINE_QOS: u16 = 28

octetsToInlineQos: offset from the end of this field to the start of inlineQos or serializedPayload. Variant with Q=false: offset = 28 (readerId..sampleSize).

Source

pub fn write_body(&self, little_endian: bool) -> (Vec<u8>, u8)

Encodes the body. Returns (bytes, flags).

Source

pub fn read_body( body: &[u8], little_endian: bool, inline_qos_flag: bool, hash_key_flag: bool, key_flag: bool, non_standard_flag: bool, ) -> Result<Self, WireError>

Decodes the body. Flags are passed by the caller from the submessage header.

§Errors

UnexpectedEof.

Trait Implementations§

Source§

impl Clone for DataFragSubmessage

Source§

fn clone(&self) -> DataFragSubmessage

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for DataFragSubmessage

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for DataFragSubmessage

Source§

impl PartialEq for DataFragSubmessage

Source§

fn eq(&self, other: &DataFragSubmessage) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for DataFragSubmessage

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.