Struct PatchOp

pub struct PatchOp(/* private fields */);

A JSON Patch operation

From the official website:

JSON Patch is a format for describing changes to a JSON document. It can be used to avoid sending a whole document when only a part has changed.

Implementations

impl PatchOp

pub fn add<T>(path: &str, value: T) -> Self

where T: Serialize,

Adds a value to an object or inserts it into an array.

In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array.

Examples

PatchOp::add("/biscuits/1", json!({ "name": "Ginger Nut" }))

pub fn remove(path: &str) -> Self

Removes a value from an object or array.

Examples

PatchOp::remove("/biscuits")

Remove the first element of the array at biscuits (or just removes the “0” key if biscuits is an object)

PatchOp::remove("/biscuits/0")

pub fn replace<T>(path: &str, value: T) -> Self

where T: Serialize,

Replaces a value.

Equivalent to a “remove” followed by an “add”.

Examples

PatchOp::replace("/biscuits/0/name", "Chocolate Digestive")

pub fn change(path: &str, diff: String) -> Self

Changes a value

Trait Implementations

impl Debug for PatchOp

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

Formats the value using the given formatter.

impl From<PatchOps> for PatchOp

fn from(ops: PatchOps) -> Self

Converts to this type from the input type.