Struct google_api_proto::google::firestore::v1::TargetChange

pub struct TargetChange {
    pub target_change_type: i32,
    pub target_ids: Vec<i32>,
    pub cause: Option<Status>,
    pub resume_token: Bytes,
    pub read_time: Option<Timestamp>,
}

Targets being watched have changed.

Fields

target_change_type: i32

The type of change that occurred.

target_ids: Vec<i32>

The target IDs of targets that have changed.

If empty, the change applies to all targets.

The order of the target IDs is not defined.

cause: Option<Status>

The error that resulted in this change, if applicable.

resume_token: Bytes

A token that can be used to resume the stream for the given target_ids, or all targets if target_ids is empty.

Not set on every target change.

read_time: Option<Timestamp>

The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot).

The stream is guaranteed to send a read_time with target_ids empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not).

For a given stream, read_time is guaranteed to be monotonically increasing.

Implementations

impl TargetChange

pub fn target_change_type(&self) -> TargetChangeType

Returns the enum value of target_change_type, or the default if the field is set to an invalid enum value.

pub fn set_target_change_type(&mut self, value: TargetChangeType)

Sets target_change_type to the provided enum value.

Trait Implementations

impl Clone for TargetChange

fn clone(&self) -> TargetChange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TargetChange

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

Formats the value using the given formatter.

impl Default for TargetChange

fn default() -> Self

Returns the “default value” for a type.

impl Message for TargetChange

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 TargetChange

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

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

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

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

impl StructuralPartialEq for TargetChange