Struct JsonWriter 

pub struct JsonWriter { /* private fields */ }

A generic writer for building patches on arbitrary JSON structures.

JsonWriter is an escape hatch for cases where you need to work with dynamic or unknown JSON structures. For typed access, prefer using derived State types.

Examples

use tirea_state::{JsonWriter, path};
use serde_json::json;

let mut w = JsonWriter::new();
w.set(path!("name"), json!("Alice"));
w.set(path!("age"), json!(30));
w.append(path!("tags"), json!("admin"));

let patch = w.build();
assert_eq!(patch.len(), 3);

Implementations

impl JsonWriter

pub fn new() -> Self

Create a new writer at the document root.

pub fn at(base: Path) -> Self

Create a new writer at the specified base path.

pub fn base(&self) -> &Path

Get the base path of this writer.

pub fn nested(&self, path: Path) -> Self

Create a nested writer at a relative path.

The nested writer will have its own operations vector. Use merge to combine its operations back into the parent.

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

Set a value at the specified path.

pub fn set_root(&mut self, value: impl Into<Value>) -> &mut Self

Set a value at the base path.

pub fn delete(&mut self, path: Path) -> &mut Self

Delete the value at the specified path.

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

Append a value to an array at the specified path.

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

Merge an object into the object at the specified path.

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

Increment a numeric value at the specified path.

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

Decrement a numeric value at the specified path.

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

Insert a value at a specific index in an array.

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

Remove the first occurrence of a value from an array.

pub fn merge<W: WriterOps>(&mut self, other: W) -> &mut Self

Merge operations from another writer into this one.

pub fn build(self) -> Patch

Consume this writer and build a patch.

pub fn is_empty(&self) -> bool

Check if this writer has any operations.

pub fn len(&self) -> usize

Get the number of operations.

pub fn clear(&mut self)

Clear all operations.

Trait Implementations

impl Clone for JsonWriter

fn clone(&self) -> JsonWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonWriter

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

Formats the value using the given formatter.

impl Default for JsonWriter

fn default() -> Self

Returns the “default value” for a type.