Enum Op 

pub enum Op {
    Set {
        path: Path,
        value: Value,
    },
    Delete {
        path: Path,
    },
    Append {
        path: Path,
        value: Value,
    },
    MergeObject {
        path: Path,
        value: Value,
    },
    Increment {
        path: Path,
        amount: Number,
    },
    Decrement {
        path: Path,
        amount: Number,
    },
    Insert {
        path: Path,
        index: usize,
        value: Value,
    },
    Remove {
        path: Path,
        value: Value,
    },
    LatticeMerge {
        path: Path,
        value: Value,
    },
}

A single patch operation.

Operations are the atomic units of change. Each operation targets a specific path in the document and performs a specific mutation.

Variants

Set

Set a value at the path.

Creates intermediate objects if they don’t exist. Returns error if array index is out of bounds.

Fields

path: Path

Target path.

value: Value

Value to set.

Delete

Delete the value at the path.

No-op if the path doesn’t exist.

Fields

path: Path

Target path.

Append

Append a value to an array at the path.

Creates the array if it doesn’t exist. Returns error if the target exists but is not an array.

Fields

path: Path

Target path (must be an array or non-existent).

value: Value

Value to append.

MergeObject

Merge an object into the object at the path.

Creates the object if it doesn’t exist. Returns error if the target exists but is not an object.

Fields

path: Path

Target path (must be an object or non-existent).

value: Value

Object to merge.

Increment

Increment a numeric value at the path.

Returns error if the target is not a number.

Fields

path: Path

Target path (must be a number).

amount: Number

Amount to increment by.

Decrement

Decrement a numeric value at the path.

Returns error if the target is not a number.

Fields

path: Path

Target path (must be a number).

amount: Number

Amount to decrement by.

Insert

Insert a value at a specific index in an array.

Shifts elements to the right. Returns error if index is out of bounds or target is not an array.

Fields

path: Path

Target path (must be an array).

index: usize

Index to insert at.

value: Value

Value to insert.

Remove

Remove the first occurrence of a value from an array.

No-op if the value is not found. Returns error if the target is not an array.

Fields

path: Path

Target path (must be an array).

value: Value

Value to remove.

LatticeMerge

Merge a lattice delta into an existing value at path.

When applied via LatticeRegistry, performs a proper lattice merge. Without a registry, falls back to Op::Set semantics (writes the delta directly).

Fields

path: Path

Target path.

value: Value

Delta value to merge.

Implementations

impl Op

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

Create a Set operation.

pub fn delete(path: Path) -> Self

Create a Delete operation.

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

Create an Append operation.

pub fn merge_object(path: Path, value: impl Into<Value>) -> Self

Create a MergeObject operation.

pub fn increment(path: Path, amount: impl Into<Number>) -> Self

Create an Increment operation.

pub fn decrement(path: Path, amount: impl Into<Number>) -> Self

Create a Decrement operation.

pub fn insert(path: Path, index: usize, value: impl Into<Value>) -> Self

Create an Insert operation.

pub fn remove(path: Path, value: impl Into<Value>) -> Self

Create a Remove operation.

pub fn lattice_merge(path: Path, value: impl Into<Value>) -> Self

Create a LatticeMerge operation.

pub fn path(&self) -> &Path

Get the path this operation targets.

pub fn path_mut(&mut self) -> &mut Path

Get a mutable reference to the path.

pub fn name(&self) -> &'static str

Get the operation name.

Trait Implementations

impl Clone for Op

fn clone(&self) -> Op

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Op

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Op

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<Op> for Patch

fn extend<I: IntoIterator<Item = Op>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Op> for Patch

fn from_iter<I: IntoIterator<Item = Op>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Op

fn eq(&self, other: &Op) -> 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 Serialize for Op

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Op