Enum Patch 

pub enum Patch<T> {
    Missing,
    Null,
    Value(T),
}

A field of a merge patch that may also be cleared: absent from the patch, set to null, or given a value.

With the serde feature, it deserializes null as Patch::Null and a value as Patch::Value; an absent field takes the default, Patch::Missing, so put #[serde(default)] on the struct (or the field). To document it with utoipa, give the field #[schema(value_type = Option<T>)]: a nullable T, as clients send it.

Variants

Missing

Absent from the patch: the field is left unchanged.

Null

Set to null: the field is cleared.

Value(T)

Given a value: the field is replaced.

Implementations

impl<T> Patch<T>

pub const fn is_missing(&self) -> bool

Whether the field is absent from the patch.

pub const fn is_null(&self) -> bool

Whether the field is set to null.

pub fn value(self) -> Option<T>

The value given, if any (None when absent or null).

pub const fn as_ref(&self) -> Patch<&T>

A reference to the value given, if any.

pub fn map<U>(self, f: impl FnOnce(T) -> U) -> Patch<U>

The patch with its value, if any, mapped by f.

pub fn try_map<U, E>( self, f: impl FnOnce(T) -> Result<U, E>, ) -> Result<Patch<U>, E>

The patch with its value, if any, mapped by the fallible f (e.g. parsing a value object), or f’s error.

Errors

Returns f’s error.

Trait Implementations

impl<T> Clone for Patch<T>

where T: Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Copy for Patch<T>

where T: Copy,

impl<T> Debug for Patch<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Patch<T>

fn default() -> Patch<T>

Returns the “default value” for a type.

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

where T: Deserialize<'de>,

null is Patch::Null, a value Patch::Value; an absent field is the default, Patch::Missing, through #[serde(default)].

fn deserialize<D>( deserializer: D, ) -> Result<Patch<T>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Eq for Patch<T>

where T: Eq,

impl<T> Hash for Patch<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> JsonSchema for Patch<T>

where T: JsonSchema,

Documented as a nullable T, as clients send it: an absent field is not in the request at all.

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.

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.

impl<T> PartialEq for Patch<T>

where T: PartialEq,

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

Equality operator ==.

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

Inequality operator !=.

impl<P, F> PatchField<Option<F>> for Patch<P>

where P: Into<F>,

fn apply_to(self, field: &mut Option<F>)

Apply the patch’s field to the model’s field.

impl<T> PatchKind for Patch<T>

const NULLABLE: bool = true

Whether a field of this kind may be set to null.

fn is_null(&self) -> bool

Whether this field is set to null.

impl<T> Serialize for Patch<T>

where T: Serialize,

A value as itself, null (and an absent field, which a struct skips with #[serde(skip_serializing_if = "Patch::is_missing")]) as null.

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for Patch<T>

where T: PartialEq,

impl<T> ValidateRange<T> for Patch<T>

where T: ValidateRange<T>,

validator’s range rule checks a given value, and passes an absent field or a null (which ValidateNonNullable checks), as it does an Option. Delegates to the value’s own check, so every type validator ranges over works.

fn greater_than(&self, max: T) -> Option<bool>

fn less_than(&self, min: T) -> Option<bool>

fn validate_range( &self, min: Option<T>, max: Option<T>, exclusive_min: Option<T>, exclusive_max: Option<T>, ) -> bool