Enum UpdateOp 

pub enum UpdateOp {
    Set {
        path: FieldPath,
        value: Option<Value>,
    },
    Merge {
        path: Option<MergePath>,
        value: Value,
    },
    Increment {
        path: FieldPath,
        by: i64,
    },
    Decrement {
        path: FieldPath,
        by: i64,
    },
    Append {
        path: Option<MergePath>,
        value: Value,
    },
    Remove {
        path: FieldPath,
    },
}

Operations that can be performed atomically on a stream value

Variants

Set

Set a value at path (overwrite)

Fields

path: FieldPath

value: Option<Value>

Merge

Merge object into existing value (object-only). Path may be omitted (root merge), a single first-level key, or an array of literal segments for nested merge. See MergePath.

Fields

path: Option<MergePath>

value: Value

Increment

Increment numeric value

Fields

path: FieldPath

by: i64

Decrement

Decrement numeric value

Fields

path: FieldPath

by: i64

Append

Append an element to an array or concatenate a string at the optional path. Path may be omitted (root append), a single first-level key, or an array of literal segments for nested append. See MergePath for the variant shape.

Fields

path: Option<MergePath>

value: Value

Remove

Remove a field

Fields

path: FieldPath

Implementations

impl UpdateOp

pub fn set(path: impl Into<FieldPath>, value: impl Into<Option<Value>>) -> Self

Create a Set operation

pub fn increment(path: impl Into<FieldPath>, by: i64) -> Self

Create an Increment operation

pub fn decrement(path: impl Into<FieldPath>, by: i64) -> Self

Create a Decrement operation

pub fn append(path: impl Into<MergePath>, value: impl Into<Value>) -> Self

Create an Append operation at a specific path. Accepts a single first-level key ("foo") or any type that converts into MergePath (e.g. Vec<String> for nested paths).

pub fn append_root(value: impl Into<Value>) -> Self

Create an Append operation at the root level (no path).

pub fn append_at_path<I, S>(segments: I, value: impl Into<Value>) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Create an Append operation at a nested path of literal segments. Convenience wrapper for append(vec!["a", "b"], v).

pub fn remove(path: impl Into<FieldPath>) -> Self

Create a Remove operation

pub fn merge(value: impl Into<Value>) -> Self

Create a Merge operation at root level

pub fn merge_at(path: impl Into<MergePath>, value: impl Into<Value>) -> Self

Create a Merge operation at a specific path. Accepts a single first-level key ("foo") or any type that converts into MergePath (e.g. Vec<String> for nested paths).

pub fn merge_at_path<I, S>(segments: I, value: impl Into<Value>) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Create a Merge operation at a nested path of literal segments. Convenience wrapper for merge_at(vec!["a", "b"], v).

Trait Implementations

impl Clone for UpdateOp

fn clone(&self) -> UpdateOp

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateOp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UpdateOp

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for UpdateOp

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for UpdateOp

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

where __S: Serializer,

Serialize this value into the given Serde serializer.