Skip to main content

ChangesStreamOptions

rouchdb_changes

Struct ChangesStreamOptions

pub struct ChangesStreamOptions {
    pub since: Seq,
    pub live: bool,
    pub include_docs: bool,
    pub doc_ids: Option<Vec<String>>,
    pub selector: Option<Value>,
    pub limit: Option<u64>,
    pub conflicts: bool,
    pub style: ChangesStyle,
    pub filter: Option<ChangesFilter>,
    pub poll_interval: Duration,
    pub timeout: Option<Duration>,
    pub heartbeat: Option<Duration>,
}

Expand description

Configuration for a changes stream.

Fields§

§since: Seq§live: bool§include_docs: bool§doc_ids: Option<Vec<String>>§selector: Option<Value>§limit: Option<u64>§conflicts: bool

Include conflicting revisions per change event.

§style: ChangesStyle

Changes style: MainOnly (default) or AllDocs.

§filter: Option<ChangesFilter>

A filter function applied post-fetch to each change event.

§poll_interval: Duration

Polling interval for live mode when no broadcast channel is available.

§timeout: Option<Duration>

How long to keep the connection open before closing in live mode.

§heartbeat: Option<Duration>

Interval for heartbeat signals in live mode (prevents connection timeout).

Trait Implementations§

impl Clone for ChangesStreamOptions

fn clone(&self) -> ChangesStreamOptions

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for ChangesStreamOptions

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

Formats the value using the given formatter. Read more

impl Default for ChangesStreamOptions

fn default() -> Self

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

Auto Trait Implementations§

impl Freeze for ChangesStreamOptions

impl !RefUnwindSafe for ChangesStreamOptions

impl Send for ChangesStreamOptions

impl Sync for ChangesStreamOptions

impl Unpin for ChangesStreamOptions

impl !UnwindSafe for ChangesStreamOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.