Struct WatchRequest 

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

WatchRequest specifies what mutations to watch for, and an optional start point for when to start watching.

Fields

optional_object_types: Vec<String>

optional_object_types is a filter of resource object types to watch for relationship 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 start from the current SpiceDB revision time of the request (“head revision”). 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.

optional_update_kinds: Vec<i32>

optional_update_kinds, if specified, indicates what kinds of mutations to include. If your SpiceDB instance is running behind a proxy that aborts idle connections, we recommend including Checkpoints to keep the stream alive even when there are no changes.

Implementations

impl WatchRequest

pub fn optional_update_kinds( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(i32) -> Option<WatchKind>>

Returns an iterator which yields the valid enum values contained in optional_update_kinds.

pub fn push_optional_update_kinds(&mut self, value: WatchKind)

Appends the provided enum value to optional_update_kinds.

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

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

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

where Self: Sized,

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

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where 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