Struct firestore_serde::firestore::DocumentRemove

pub struct DocumentRemove {
    pub document: String,
    pub removed_target_ids: Vec<i32, Global>,
    pub read_time: Option<Timestamp>,
}

A [Document][google.firestore.v1.Document] has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.

Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

Fields

document: String

The resource name of the [Document][google.firestore.v1.Document] that has gone out of view.

removed_target_ids: Vec<i32, Global>

A set of target IDs for targets that previously matched this document.

read_time: Option<Timestamp>

The read timestamp at which the remove was observed.

Greater or equal to the commit_time of the change/delete/remove.

Trait Implementations

impl Clone for DocumentRemove

pub fn clone(&self) -> DocumentRemove

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentRemove

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

Formats the value using the given formatter.

impl Default for DocumentRemove

pub fn default() -> DocumentRemove

Returns the “default value” for a type.

impl Message for DocumentRemove

pub fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

pub fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

pub fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

pub 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<DocumentRemove> for DocumentRemove

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

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

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

This method tests for !=.

impl StructuralPartialEq for DocumentRemove