Struct google_firestore1_beta1::FieldTransform

pub struct FieldTransform {
    pub field_path: Option<String>,
    pub append_missing_elements: Option<ArrayValue>,
    pub set_to_server_value: Option<String>,
    pub remove_all_from_array: Option<ArrayValue>,
}

A transformation of a field of the document.

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

Fields

field_path: Option<String>

The path of the field. See Document.fields for the field path syntax reference.

append_missing_elements: Option<ArrayValue>

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

set_to_server_value: Option<String>

Sets the field to the given server value.

remove_all_from_array: Option<ArrayValue>

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

Trait Implementations

impl Default for FieldTransform

fn default() -> FieldTransform

Returns the "default value" for a type.

impl Clone for FieldTransform

fn clone(&self) -> FieldTransform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldTransform

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

Formats the value using the given formatter.

impl Part for FieldTransform