Struct etcd_client::WatchResponse

pub struct WatchResponse(/* private fields */);

Response for Watch operation.

Implementations

impl WatchResponse

pub fn header(&self) -> Option<&ResponseHeader>

Watch response header.

pub fn take_header(&mut self) -> Option<ResponseHeader>

Takes the header out of the response, leaving a None in its place.

pub const fn watch_id(&self) -> i64

The ID of the watcher that corresponds to the response.

pub const fn created(&self) -> bool

created is set to true if the response is for a create watch request. The client should record the watch_id and expect to receive events for the created watcher from the same stream. All events sent to the created watcher will attach with the same watch_id.

pub const fn canceled(&self) -> bool

canceled is set to true if the response is for a cancel watch request. No further events will be sent to the canceled watcher.

pub const fn compact_revision(&self) -> i64

compact_revision is set to the minimum index if a watcher tries to watch at a compacted index.

This happens when creating a watcher at a compacted revision or the watcher cannot catch up with the progress of the key-value store.

The client should treat the watcher as canceled and should not try to create any watcher with the same start_revision again.

pub fn cancel_reason(&self) -> &str

Indicates the reason for canceling the watcher.

pub fn events(&self) -> &[Event]

Events happened on the watched keys.

Trait Implementations

impl Clone for WatchResponse

fn clone(&self) -> WatchResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WatchResponse

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

Formats the value using the given formatter.