Struct DocumentMask

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

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, and takes in account the dynamic nature of Value.

This type is not used in any activity, and only used as part of another schema.

Fields

field_paths: Option<Vec<String>>

The list of field paths in the mask. See Document.fields for a field path syntax reference.

Trait Implementations

impl Clone for DocumentMask

fn clone(&self) -> DocumentMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentMask

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

Formats the value using the given formatter.

impl Default for DocumentMask

fn default() -> DocumentMask

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocumentMask

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DocumentMask

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for DocumentMask