Enum PatchOperation 

pub enum PatchOperation {
    Add {
        path: String,
        value: Value,
    },
    Remove {
        path: String,
    },
    Replace {
        path: String,
        value: Value,
    },
    Move {
        from: String,
        path: String,
    },
    Copy {
        from: String,
        path: String,
    },
    Test {
        path: String,
        value: Value,
    },
}

A single RFC 6902 operation.

The serde representation is the RFC wire format exactly: an object with an op discriminator, a path JSON Pointer, and — depending on the operation — a value or a from pointer.

Why value has a default

Upstream types both patch fields as z.array(z.any()) / List[Any] and validates nothing, so a producer that drops value still parses there. The case is not hypothetical: JSON.stringify({op: "add", path: "/x", value: undefined}) yields {"op":"add","path":"/x"}, which is what a JavaScript producer emits whenever the new state holds undefined at that key. Making value required would turn that into a deserialization failure for the whole STATE_DELTA event — and in an SSE stream a failed event is usually a failed run. An omitted value therefore reads as JSON null, which is how the JavaScript patch libraries apply it, and re-serializes explicitly as null.

Everything else about the operation stays strictly typed: an unrecognized op is still rejected, because the six RFC operations are the whole vocabulary and a seventh is a producer bug worth surfacing rather than carrying silently to an applier that cannot execute it.

let op = PatchOperation::Replace {
    path: "/counter".into(),
    value: serde_json::json!(2),
};
assert_eq!(
    serde_json::to_string(&op).unwrap(),
    r#"{"op":"replace","path":"/counter","value":2}"#
);

Variants

Add

Inserts value at path, shifting array elements right when path ends in an array index or -.

Fields

path: String

JSON Pointer to the location to add.

value: Value

The value to insert. An omitted value reads as null; see the type-level docs.

Remove

Removes the value at path.

Fields

path: String

JSON Pointer to the location to remove.

Replace

Replaces the value at path, which must already exist.

Fields

path: String

JSON Pointer to the location to overwrite.

value: Value

The replacement value. An omitted value reads as null.

Move

Moves the value at from to path.

Fields

from: String

JSON Pointer to the source location.

path: String

JSON Pointer to the destination.

Copy

Copies the value at from to path.

Fields

from: String

JSON Pointer to the source location.

path: String

JSON Pointer to the destination.

Test

Asserts that the value at path equals value; a failed test aborts the whole patch.

Fields

path: String

JSON Pointer to the location to test.

value: Value

The value the location is expected to hold. An omitted value reads as null.

Implementations

impl PatchOperation

pub fn add(path: impl Into<String>, value: impl Into<Value>) -> Self

Builds an Add operation.

pub fn remove(path: impl Into<String>) -> Self

Builds a Remove operation.

pub fn replace(path: impl Into<String>, value: impl Into<Value>) -> Self

Builds a Replace operation.

pub fn mv(from: impl Into<String>, path: impl Into<String>) -> Self

Builds a Move operation.

pub fn copy(from: impl Into<String>, path: impl Into<String>) -> Self

Builds a Copy operation.

pub fn test(path: impl Into<String>, value: impl Into<Value>) -> Self

Builds a Test operation.

pub const fn op(&self) -> &'static str

The op string as it appears on the wire.

pub fn path(&self) -> &str

The JSON Pointer this operation targets.

pub fn from(&self) -> Option<&str>

The source pointer of a move or copy, or None for other operations.

pub const fn value(&self) -> Option<&Value>

The payload of an add, replace or test, or None for other operations.

Trait Implementations

impl Clone for PatchOperation

fn clone(&self) -> PatchOperation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for PatchOperation

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for PatchOperation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PatchOperation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PatchOperation

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for PatchOperation

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

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 PatchOperation

impl ToSchema for PatchOperation

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.