Struct reql::cmd::changes::Options

#[non_exhaustive]
pub struct Options {
    pub squash: Option<Squash>,
    pub changefeed_queue_size: Option<u32>,
    pub include_initial: Option<bool>,
    pub include_states: Option<bool>,
    pub include_offsets: Option<bool>,
    pub include_types: Option<bool>,
}

Optional arguments to changes

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

squash: Option<Squash>

Controls how change notifications are batched

changefeed_queue_size: Option<u32>

The number of changes the server will buffer between client reads before it starts dropping changes and generates an error (default: 100,000).

include_initial: Option<bool>

If true, the changefeed stream will begin with the current contents of the table or selection being monitored. These initial results will have new_val fields, but no old_val fields. The initial results may be intermixed with actual changes, as long as an initial result for the changed document has already been given. If an initial result for a document has been sent and a change is made to that document that would move it to the unsent part of the result set (e.g., a changefeed monitors the top 100 posters, the first 50 have been sent, and poster 48 has become poster 52), an “uninitial” notification will be sent, with an old_val field but no new_val field.

include_states: Option<bool>

If true, the changefeed stream will include special status documents consisting of the field state and a string indicating a change in the feed’s state. These documents can occur at any point in the feed between the notification documents described below. If includeStates is false (the default), the status documents will not be sent.

include_offsets: Option<bool>

If true, a changefeed stream on an order_by.limit changefeed will include old_offset and new_offset fields in status documents that include old_val and new_val. This allows applications to maintain ordered lists of the stream’s result set. If old_offset is set and not null, the element at old_offset is being deleted; if new_offset is set and not null, then new_val is being inserted at new_offset. Setting include_offsets to true on a changefeed that does not support it will raise an error.

include_types: Option<bool>

If true, every result on a changefeed will include a type field with a string that indicates the kind of change the result represents: add, remove, change, initial, uninitial, state. Defaults to false.

There are currently two states:

• {state: 'initializing'} indicates the following documents represent initial values on the feed rather than changes. This will be the first document of a feed that returns initial values.
• {state: 'ready'} indicates the following documents represent changes. This will be the first document of a feed that does not return initial values; otherwise, it will indicate the initial values have all been sent.

Implementations

impl Options

pub fn new() -> Self

pub fn squash(self, squash: Squash) -> Self

pub fn changefeed_queue_size(self, changefeed_queue_size: u32) -> Self

pub fn include_initial(self, include_initial: bool) -> Self

pub fn include_states(self, include_states: bool) -> Self

pub fn include_offsets(self, include_offsets: bool) -> Self

pub fn include_types(self, include_types: bool) -> Self

Trait Implementations

impl Arg for Options

fn arg(self) -> Arg<Options>

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl PartialEq<Options> for Options

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Options> for Options

fn partial_cmp(&self, other: &Options) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Options

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

Serialize this value into the given Serde serializer.

impl Copy for Options

impl StructuralPartialEq for Options