Struct PatchOps

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

Multiple patch operations

Implementations

impl PatchOps

pub const fn new() -> Self

Prepare for multiple patch operations

pub fn add<T>(self, 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

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

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

Removes a value from an object or array.

Examples

PatchOps::new().remove("/biscuits")

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

PatchOps::new().remove("/biscuits/0")

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

where T: Serialize,

Replaces a value.

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

Examples

PatchOps::new().replace("/biscuits/0/name", "Chocolate Digestive")

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

Changes a value

Trait Implementations

impl Debug for PatchOps

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

Formats the value using the given formatter.

impl Default for PatchOps

fn default() -> PatchOps

Returns the “default value” for a type.

impl From<PatchOps> for PatchOp

fn from(ops: PatchOps) -> Self

Converts to this type from the input type.