Struct WatchResponse 

pub struct WatchResponse {
    pub updates: Vec<RelationshipUpdate>,
    pub changes_through: Option<ZedToken>,
    pub optional_transaction_metadata: Option<Struct>,
    pub schema_updated: bool,
    pub is_checkpoint: bool,
    pub full_revision_metadata: Vec<Struct>,
}

WatchResponse contains all mutation events in ascending timestamp order. This excludes relationships that were deleted because they expired. The response includes a field that can be used to resume watching from that point.

Fields

updates: Vec<RelationshipUpdate>

updates are the RelationshipUpdate events that have occurred since the call was made, or since the point in time specified by changes_through.

changes_through: Option<ZedToken>

changes_through is the ZedToken that represents the point in time that the watch response is current through. This token can be used in a subsequent WatchRequest to resume watching from this point.

optional_transaction_metadata: Option<Struct>

optional_transaction_metadata is an optional field that returns the transaction metadata given to SpiceDB during the transaction that produced the changes in this response. This field may not exist if no transaction metadata was provided, or if multiple pieces of metadata were found during the transaction (in which case it is ambiguous which to return).

schema_updated: bool

schema_updated, if true, indicates that the schema was changed in this revision.

is_checkpoint: bool

is_checkpoint, if true, indicates that a checkpoint was reached. A checkpoint indicates that the server guarantees that the client will not observe any changes at a revision below or equal to the revision in this response.

full_revision_metadata: Vec<Struct>

full_revision_metadata contains all transaction metadata given to SpiceDB during the revision that produced the changes in this response. Some datastores (such as CockroachDB) can “merge” multiple transactions into a single revision (if the changes occurred concurrently), so this field is a list of all transaction metadata seen during the revision.

Trait Implementations

impl Clone for WatchResponse

fn clone(&self) -> WatchResponse

Returns a duplicate 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(&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 WatchResponse

fn eq(&self, other: &WatchResponse) -> 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 WatchResponse