Struct etcdv3client::pb::WatchCreateRequest

pub struct WatchCreateRequest {
    pub key: Vec<u8>,
    pub range_end: Vec<u8>,
    pub start_revision: i64,
    pub progress_notify: bool,
    pub filters: Vec<i32>,
    pub prev_kv: bool,
    pub watch_id: i64,
    pub fragment: bool,
}

Fields

key: Vec<u8>

key is the key to register for watching.

range_end: Vec<u8>

range_end is the end of the range [key, range_end) to watch. If range_end is not given, only the key argument is watched. If range_end is equal to '\0', all keys greater than or equal to the key argument are watched. If the range_end is one bit larger than the given key, then all keys with the prefix (the given key) will be watched.

start_revision: i64

start_revision is an optional revision to watch from (inclusive). No start_revision is "now".

progress_notify: bool

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.

filters: Vec<i32>

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

prev_kv: bool

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.

watch_id: i64

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.

fragment: bool

fragment enables splitting large revisions into multiple watch responses.

Methods

impl WatchCreateRequest

pub fn filters(
    &self
) -> FilterMap<Cloned<Iter<i32>>, fn(_: i32) -> Option<FilterType>>

pub fn push_filters(&mut self, value: FilterType)

Trait Implementations

impl Clone for WatchCreateRequest

fn clone(&self) -> WatchCreateRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for WatchCreateRequest

fn default() -> WatchCreateRequest

Returns the "default value" for a type.

impl PartialEq<WatchCreateRequest> for WatchCreateRequest

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

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

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

This method tests for !=.

impl Debug for WatchCreateRequest

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

Formats the value using the given formatter.

impl StructuralPartialEq for WatchCreateRequest

impl Message for WatchCreateRequest

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(&mut self, buf: &mut B) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: IntoBuf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: IntoBuf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: IntoBuf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: IntoBuf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.