Struct gapi_grpc::google::firestore::v1::DocumentMask

[+] Show declaration

pub struct DocumentMask {
    pub field_paths: Vec<String>,
}

[−] Expand description

A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a [Document][google.firestore.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value].

Fields

field_paths: Vec<String>

[−] Expand description

The list of field paths in the mask. See [Document.fields][google.firestore.v1.Document.fields] for a field path syntax reference.

Trait Implementations

impl Clone for DocumentMask[+]

[+] Show hidden undocumented items

fn clone(&self) -> DocumentMask[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for DocumentMask[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for DocumentMask[+]

[+] Show hidden undocumented items

fn default() -> DocumentMask[−]

Returns the “default value” for a type.

impl Message for DocumentMask[+]

[+] Show hidden undocumented items

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

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

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.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, [−]

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, [−]

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

pub 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.

pub 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<DocumentMask> for DocumentMask[+]

[+] Show hidden undocumented items

fn eq(&self, other: &DocumentMask) -> bool[−]

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

fn ne(&self, other: &DocumentMask) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for DocumentMask