Struct PatchObject 

#[non_exhaustive]
pub struct PatchObject(/* private fields */);

A JMAP PatchObject (RFC 8620 §5.3) — a String → JSON map describing the changes to apply to a record during */set update.

See the module documentation for the path-key semantics and null-leaf removal rule.

Wire format

PatchObject serialises and deserialises as a plain JSON object via #[serde(transparent)]. There is no discriminant or wrapper key on the wire — {"name": "New"} and PatchObject::from_map([("name", json!("New"))]) are equivalent.

Example

use jmap_types::PatchObject;
use serde_json::{json, Map, Value};

let mut m = Map::new();
m.insert("name".to_owned(), json!("Renamed"));
m.insert("keywords/$flagged".to_owned(), Value::Null);
let patch = PatchObject::from_map(m);

// Wire form is byte-identical to the inner map.
let wire = serde_json::to_string(&patch).unwrap();
assert!(wire.contains("\"name\":\"Renamed\""));
assert!(wire.contains("\"keywords/$flagged\":null"));

Implementations

impl PatchObject

pub fn new() -> Self

Construct an empty patch.

An empty patch is a valid no-op update value per RFC 8620 §5.3: the server accepts it and applies no changes to the target record.

pub fn from_map(map: Map<String, Value>) -> Self

Wrap an existing serde_json::Map as a PatchObject.

No validation is performed — the caller is responsible for the keys conforming to RFC 8620 §5.3 path syntax (or the server will reject the patch with invalidPatch).

pub fn as_map(&self) -> &Map<String, Value>

Borrow the inner map.

pub fn as_map_mut(&mut self) -> &mut Map<String, Value>

Mutably borrow the inner map for in-place edits.

pub fn into_inner(self) -> Map<String, Value>

Consume the PatchObject and return the underlying map.

pub fn is_empty(&self) -> bool

true if the patch contains no key/value pairs.

pub fn len(&self) -> usize

Number of key/value pairs in the patch.

Trait Implementations

impl Clone for PatchObject

fn clone(&self) -> PatchObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PatchObject

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

Formats the value using the given formatter.

impl Default for PatchObject

fn default() -> PatchObject

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PatchObject

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Map<String, Value>> for PatchObject

fn from(map: Map<String, Value>) -> Self

Converts to this type from the input type.

impl From<PatchObject> for Map<String, Value>

fn from(patch: PatchObject) -> Self

Converts to this type from the input type.

impl PartialEq for PatchObject

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

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 PatchObject