Skip to main content

CacheChange

Struct CacheChange 

Source
pub struct CacheChange {
    pub sequence_number: SequenceNumber,
    pub payload: Arc<[u8]>,
    pub kind: ChangeKind,
    pub key_hash: Option<[u8; 16]>,
    pub source_timestamp: Option<HeTimestamp>,
}
Expand description

Single cache entry.

payload is held as Arc<[u8]> — the cache, the writer build- datagram path and reader delivery share a single allocation. This saves the n-fold Vec::clone() per reader proxy in the reliable-writer tick (perf audit F7/F8/F10, ~30-50 % throughput gain for large payloads).

Fields§

§sequence_number: SequenceNumber

Sequence number (writer-locally unique).

§payload: Arc<[u8]>

Payload (serialized sample), reference-counted.

§kind: ChangeKind

Kind of the event.

§key_hash: Option<[u8; 16]>

Optional PID_KEY_HASH from the inline QoS (Spec §9.6.4.8). Reader side: filled for keyed topics + ALIVE samples with an inline hash or for lifecycle markers (Disposed/Unregistered) by the reader path. Writer side: set by the writer when the path propagates the hash along the sample pipeline.

§source_timestamp: Option<HeTimestamp>

Source timestamp of the write (DDSI-RTPS §8.3.7.9 / §8.7.3). When set, the writer prepends an INFO_TS submessage before the DATA so a remote reader can populate SampleInfo.source_timestamp and apply DESTINATION_ORDER = BY_SOURCE_TIMESTAMP. None ⇒ no INFO_TS (the reader falls back to reception order). Held on the change so retransmits carry the original timestamp, not the resend wall-clock.

Implementations§

Source§

impl CacheChange

Source

pub fn alive(sn: SequenceNumber, payload: Vec<u8>) -> Self

Creates an alive change. Takes Vec<u8> and converts once into Arc<[u8]>. For call sites that already have the allocation as an Arc, there is Self::alive_arc.

Source

pub fn with_source_timestamp(self, ts: Option<HeTimestamp>) -> Self

Attaches a source timestamp (builder style). The writer emits an INFO_TS submessage before the DATA for any change that carries one.

Source

pub fn lifecycle(sn: SequenceNumber, payload: Vec<u8>, kind: ChangeKind) -> Self

Creates a lifecycle marker (Spec §8.2.1.2). payload is the key-only serialization of the disposed/unregistered instance — exactly what lands as PID_KEY_HASH in the inline QoS.

Trait Implementations§

Source§

impl Clone for CacheChange

Source§

fn clone(&self) -> CacheChange

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 CacheChange

Source§

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

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

impl Eq for CacheChange

Source§

impl PartialEq for CacheChange

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for CacheChange

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.