Struct etcd_client::proto::PbWatchResponse

pub struct PbWatchResponse {
    pub header: Option<ResponseHeader>,
    pub watch_id: i64,
    pub created: bool,
    pub canceled: bool,
    pub compact_revision: i64,
    pub cancel_reason: String,
    pub fragment: bool,
    pub events: Vec<Event>,
}

This is supported on crate feature pub-response-field only.

Fields

header: Option<ResponseHeader>

watch_id: i64

watch_id is the ID of the watcher that corresponds to the response.

created: 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.

canceled: 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.

compact_revision: 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.

cancel_reason: String

cancel_reason indicates the reason for canceling the watcher.

fragment: bool

framgment is true if large watch response was split over multiple responses.

events: Vec<Event>

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.

impl Default for WatchResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for WatchResponse

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_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated 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 encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

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

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

Decodes an instance of the message from a buffer.

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

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

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

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: Buf, 

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

impl PartialEq<WatchResponse> for WatchResponse

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

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

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

This method tests for !=.

impl StructuralPartialEq for WatchResponse