Skip to main content

Patch

Enum Patch 

Source
pub enum Patch<T> {
    Keep,
    Set(T),
    Clear,
}
Expand description

Three-way patch value for nullable JMAP fields.

  • Keep (default): the field is omitted from the patch — server leaves it unchanged.
  • Set(v): the field is included with value v.
  • Clear: the field is included as JSON null (clears the server-side value).

Use Patch::from(v) to construct Set(v). Use Default::default() or Patch::Keep to leave the field unchanged. Use Patch::Clear to set a nullable field to null explicitly.

§Serde usage

Fields of type Patch<T> must carry both attributes:

#[serde(default, skip_serializing_if = "Patch::is_keep")]
pub my_field: Patch<String>,
  • default: absent JSON key → Patch::Keep (no change).
  • skip_serializing_if: omits the key from the output when the value is Keep.

Without skip_serializing_if, Patch::Keep serializes as a runtime error.

§Deserialization

Patch::Keep is not reachable from JSON deserialization. The custom Deserialize impl maps JSON nullClear and a JSON value → Set(v). An absent key (via #[serde(default)]) produces Keep via Default.

Variants§

§

Keep

Omit the field from the patch — server leaves it unchanged.

§

Set(T)

Include the field with value T.

§

Clear

Include the field as JSON null (clears the server-side value).

Implementations§

Source§

impl<T> Patch<T>

Source

pub fn is_keep(&self) -> bool

Returns true if this is Patch::Keep (field should be omitted from serialization).

Source§

impl<T: Serialize> Patch<T>

Source

pub fn map_entry(&self) -> Result<Option<Value>, Error>

Returns None when Keep (omit key from patch), Some(Value::Null) when Clear, or Some(serialized_value) when Set.

Trait Implementations§

Source§

impl<T: Clone> Clone for Patch<T>

Source§

fn clone(&self) -> Patch<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Patch<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for Patch<T>

Source§

fn default() -> Patch<T>

Returns the “default value” for a type. Read more
Source§

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Patch<T>

Source§

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T> From<T> for Patch<T>

Source§

fn from(v: T) -> Self

Converts to this type from the input type.
Source§

impl<T: PartialEq> PartialEq for Patch<T>

Source§

fn eq(&self, other: &Patch<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Serialize> Serialize for Patch<T>

Source§

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl<T> StructuralPartialEq for Patch<T>

Auto Trait Implementations§

§

impl<T> Freeze for Patch<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Patch<T>
where T: RefUnwindSafe,

§

impl<T> Send for Patch<T>
where T: Send,

§

impl<T> Sync for Patch<T>
where T: Sync,

§

impl<T> Unpin for Patch<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Patch<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Patch<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<!> for T

Source§

fn from(t: !) -> T

Converts to this type from the input type.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,