Struct WatchRequest

pub struct WatchRequest {
    pub optional_object_types: Vec<String>,
    pub optional_start_cursor: Option<ZedToken>,
    pub optional_relationship_filters: Vec<RelationshipFilter>,
}

WatchRequest specifies the object definitions for which we want to start watching mutations, and an optional start snapshot for when to start watching.

Fields

optional_object_types: Vec<String>

optional_object_types is a filter of resource object types to watch for changes. If specified, only changes to the specified object types will be returned and optional_relationship_filters cannot be used.

optional_start_cursor: Option<ZedToken>

optional_start_cursor is the ZedToken holding the point-in-time at which to start watching for changes. If not specified, the watch will begin at the current head revision of the datastore, returning any updates that occur after the caller makes the request. Note that if this cursor references a point-in-time containing data that has been garbage collected, an error will be returned.

optional_relationship_filters: Vec<RelationshipFilter>

optional_relationship_filters, if specified, indicates the filter(s) to apply to each relationship to be returned by watch. The relationship will be returned as long as at least one filter matches, this allows clients to match relationships on multiple filters on a single watch call. If specified, optional_object_types cannot be used.

Trait Implementations

impl Clone for WatchRequest

fn clone(&self) -> WatchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WatchRequest

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

Formats the value using the given formatter.

impl Default for WatchRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for WatchRequest

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, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where B: BufMut, Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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, Self: Sized,

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, Self: Sized,

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

impl PartialEq for WatchRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for WatchRequest