Skip to main content

SubUpdate

Struct SubUpdate 

Source
pub struct SubUpdate {
    pub topic: Option<Arc<str>>,
    pub data: Payload,
    pub skipped: u64,
    pub snapshot_end: bool,
}
Expand description

One update delivered on a subscription stream (server Session::subscribe and client ClientHandle::subscribe alike).

topic names the concrete record that fired: Some on wildcard subscriptions, which fan in many records under one subscription id, and on any transport that tags every event; None on an exact-topic subscription.

Fields§

§topic: Option<Arc<str>>

Concrete record topic that fired, when the producer side tags it.

§data: Payload

The serialized record value.

§skipped: u64

Count of skipped records

§snapshot_end: bool

Set on the last update of the late-join snapshot burst, carrying its total skipped.

Only set when the burst produced a final update to carry it — an empty burst, an exact-topic subscribe, or a tail that failed to encode end without one — so its absence says nothing.

Implementations§

Source§

impl SubUpdate

Source

pub fn new(data: Payload) -> Self

An untagged update (exact-topic subscription).

Source

pub fn tagged(topic: Arc<str>, data: Payload) -> Self

A topic-tagged update (wildcard / bus subscription).

Source

pub fn with_skipped(self, n: u64) -> Self

Mark that n updates were lost on this subscription immediately before this one (0 leaves the update lossless).

Source

pub fn with_snapshot_end(self) -> Self

Mark this update as the last of the late-join snapshot burst (see snapshot_end).

Trait Implementations§

Source§

impl Clone for SubUpdate

Source§

fn clone(&self) -> SubUpdate

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 SubUpdate

Source§

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

Formats the value using the given formatter. Read more

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.