Struct etcd_client::WatchOptions

pub struct WatchOptions { /* fields omitted */ }

Options for Watch operation.

Implementations

impl WatchOptions

pub const fn new() -> Self

Creates a new WatchOptions.

pub fn with_range(mut self: Self, end: impl Into<Vec<u8>>) -> Self

Sets the end of the range [key, end) to watch. If end is not given, only the key argument is watched. If end is equal to '\0', all keys greater than or equal to the key argument are watched.

pub fn with_from_key(mut self: Self) -> Self

Watches all keys >= key.

pub fn with_prefix(mut self: Self) -> Self

Watches all keys prefixed with key.

pub fn with_all_keys(mut self: Self) -> Self

Watches all keys.

pub const fn with_start_revision(mut self: Self, revision: i64) -> Self

Sets the revision to watch from (inclusive). No start_revision is "now".

pub const fn with_progress_notify(mut self: Self) -> Self

progress_notify is set so that the etcd server will periodically send a WatchResponse with no events to the new watcher if there are no recent events. It is useful when clients wish to recover a disconnected watcher starting from a recent known revision. The etcd server may decide how often it will send notifications based on current load.

pub fn with_filters(
    mut self: Self,
    filters: impl Into<Vec<WatchFilterType>>
) -> Self

Filter the events at server side before it sends back to the watcher.

pub const fn with_prev_key(mut self: Self) -> Self

If prev_kv is set, created watcher gets the previous KV before the event happens. If the previous KV is already compacted, nothing will be returned.

pub const fn with_watch_id(mut self: Self, watch_id: i64) -> Self

If watch_id is provided and non-zero, it will be assigned to this watcher. Since creating a watcher in etcd is not a synchronous operation, this can be used ensure that ordering is correct when creating multiple watchers on the same stream. Creating a watcher with an ID already in use on the stream will cause an error to be returned.

pub const fn with_fragment(mut self: Self) -> Self

Enables splitting large revisions into multiple watch responses.

Trait Implementations

impl Clone for WatchOptions

pub fn clone(&self) -> WatchOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WatchOptions

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

Formats the value using the given formatter.

impl Default for WatchOptions

pub fn default() -> WatchOptions

Returns the "default value" for a type.