Struct FirestoreFieldTransform

pub struct FirestoreFieldTransform {
    pub field: String,
    pub transform_type: FirestoreFieldTransformType,
}

Represents a transformation to apply to a specific field within a document.

Field transformations allow for atomic, server-side modifications of document fields, such as incrementing a number, setting a field to the server’s timestamp, or manipulating array elements.

Fields

field: String

The dot-separated path to the field to transform (e.g., “user.profile.age”).

transform_type: FirestoreFieldTransformType

The type of transformation to apply.

Implementations

impl FirestoreFieldTransform

pub fn new(field: String, transform_type: FirestoreFieldTransformType) -> Self

pub fn field(&mut self, value: String) -> &mut Self

pub fn with_field(self, value: String) -> Self

pub fn transform_type( &mut self, value: FirestoreFieldTransformType, ) -> &mut Self

pub fn with_transform_type(self, value: FirestoreFieldTransformType) -> Self

Trait Implementations

impl Clone for FirestoreFieldTransform

fn clone(&self) -> FirestoreFieldTransform

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FirestoreFieldTransform

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

Formats the value using the given formatter.

impl FirestoreTransformExpr for FirestoreFieldTransform

fn build_transform(self) -> Option<FirestoreFieldTransform>

Builds the FirestoreFieldTransform. Returns None if the expression represents an empty or no-op transform.

impl From<FirestoreFieldTransformInit> for FirestoreFieldTransform

fn from(value: FirestoreFieldTransformInit) -> Self

Converts to this type from the input type.

impl PartialEq for FirestoreFieldTransform

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryInto<FieldTransform> for FirestoreFieldTransform

type Error = FirestoreError

The type returned in the event of a conversion error.

fn try_into(self) -> Result<FieldTransform, Self::Error>

Performs the conversion.

impl StructuralPartialEq for FirestoreFieldTransform