Skip to main content

SubscriptionOptions

Struct SubscriptionOptions 

Source
pub struct SubscriptionOptions {
    pub batch_size: Option<usize>,
    pub last_rows: Option<u32>,
    pub from: Option<SeqId>,
    pub auto_fetch_batches: Option<bool>,
}
Expand description

Options for live query subscriptions.

Fields§

§batch_size: Option<usize>

Hint for server-side batch sizing during initial data load.

§last_rows: Option<u32>

Number of last (newest) rows to fetch for initial data.

§from: Option<SeqId>

Resume subscription from a specific sequence ID.

§auto_fetch_batches: Option<bool>

Client-side control for automatically requesting subsequent initial data batches.

Implementations§

Source§

impl SubscriptionOptions

Source

pub fn new() -> SubscriptionOptions

Create new subscription options with defaults.

Source

pub fn with_batch_size(self, size: usize) -> SubscriptionOptions

Set the batch size for initial data loading.

Source

pub fn with_last_rows(self, count: u32) -> SubscriptionOptions

Set the number of last rows to fetch.

Source

pub fn with_from(self, seq_id: SeqId) -> SubscriptionOptions

Resume from a specific sequence ID.

Source

pub fn with_from_seq_id(self, seq_id: SeqId) -> SubscriptionOptions

Resume from a specific sequence ID via deprecated alias.

Source

pub fn with_auto_fetch_batches(self, enabled: bool) -> SubscriptionOptions

Control whether the client should automatically request subsequent initial data batches.

Source

pub fn has_resume_seq_id(&self) -> bool

Check if this contains a resume seq_id.

Trait Implementations§

Source§

impl Clone for SubscriptionOptions

Source§

fn clone(&self) -> SubscriptionOptions

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 SubscriptionOptions

Source§

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

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

impl Default for SubscriptionOptions

Source§

fn default() -> SubscriptionOptions

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SubscriptionOptions

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<SubscriptionOptions, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SubscriptionOptions

Source§

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

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SubscriptionOptions

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more