Struct PatchBuilder 

pub struct PatchBuilder { /* private fields */ }

A builder for constructing JSON Patches programmatically.

This provides a more ergonomic way to create patches when you know exactly what operations you want to perform.

Example

use ag_ui_core::patch::PatchBuilder;
use serde_json::json;

let patch = PatchBuilder::new()
    .add("/name", json!("Alice"))
    .replace("/age", json!(31))
    .remove("/temp")
    .build();

assert_eq!(patch.0.len(), 3);

Implementations

impl PatchBuilder

pub fn new() -> Self

Creates a new empty patch builder.

pub fn add(self, path: impl AsRef<str>, value: JsonValue) -> Self

Adds an “add” operation to the patch.

The add operation adds a value at the target location. If the target location specifies an array index, the value is inserted at that index.

pub fn remove(self, path: impl AsRef<str>) -> Self

Adds a “remove” operation to the patch.

The remove operation removes the value at the target location.

pub fn replace(self, path: impl AsRef<str>, value: JsonValue) -> Self

Adds a “replace” operation to the patch.

The replace operation replaces the value at the target location with the new value.

pub fn move_value(self, from: impl AsRef<str>, path: impl AsRef<str>) -> Self

Adds a “move” operation to the patch.

The move operation removes the value at a specified location and adds it to the target location.

pub fn copy(self, from: impl AsRef<str>, path: impl AsRef<str>) -> Self

Adds a “copy” operation to the patch.

The copy operation copies the value at a specified location to the target location.

pub fn test(self, path: impl AsRef<str>, value: JsonValue) -> Self

Adds a “test” operation to the patch.

The test operation tests that a value at the target location is equal to a specified value. If the test fails, the entire patch fails.

pub fn build(self) -> Patch

Builds the patch from the accumulated operations.

pub fn build_vec(self) -> Vec<JsonValue>

Builds the patch and returns it as a vector of JSON values.

This is the format expected by StateDeltaEvent and ActivityDeltaEvent.

Trait Implementations

impl Clone for PatchBuilder

fn clone(&self) -> PatchBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PatchBuilder

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

Formats the value using the given formatter.

impl Default for PatchBuilder

fn default() -> PatchBuilder

Returns the “default value” for a type.