Skip to main content

MetadataChangesParams

Struct MetadataChangesParams 

Source
pub struct MetadataChangesParams {
    pub filter_related_type: Option<String>,
    pub filter_metadata_type: Option<Vec<String>>,
    pub extra: Map<String, Value>,
}
Expand description

Extra method-level arguments for Metadata/changes (draft-ietf-jmap-metadata-01 §3.3).

Both filter fields are optional. Pass None (or Default::default()) to fetch all Metadata changes regardless of relatedType or @type.

Per §3.3, when both filters are specified the server MUST return only changes to Metadata objects that satisfy both criteria (logical AND). The state token returned in the response represents the complete account state and is independent of the filters; clients that use these filters MUST re-use the same filter values across subsequent Metadata/changes calls to ensure consistent synchronisation.

Fields§

§filter_related_type: Option<String>

Restrict the created/updated/destroyed arrays in the response to Metadata objects whose relatedType equals this value (draft-ietf-jmap-metadata-01 §3.3).

§filter_metadata_type: Option<Vec<String>>

Restrict the created/updated/destroyed arrays in the response to Metadata objects whose @type is in this list (draft-ietf-jmap-metadata-01 §3.3).

None disables filtering on @type (all types are returned). Some(vec![]) is a legal empty array meaning “match no @type values” per draft §3.3 — the server returns empty created / updated / destroyed arrays regardless of actual changes. If you mean “return everything”, use None, not Some(vec![]).

§extra: Map<String, Value>

Catch-all for vendor / site / private extension fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace extras-preservation policy (see workspace AGENTS.md).

Constraint: keys in extra MUST NOT collide with the typed-field wire names above (the camelCase spelling — e.g. "accountId", "ids", "properties", "blobIds", "fromAccountId", etc.). On collision the typed-field value wins on the wire and the extra value is silently dropped at serialization. Place vendor extensions under vendor-prefixed keys (e.g. "acmeCorpFoo") to avoid the collision class.

Keys MUST NOT collide with the standard RFC 8620 §5.2 / draft-01 §3.3 arg names (accountId, sinceState, maxChanges, filterRelatedType, filterMetadataType); metadata_changes will silently retain the typed-field value if an extras key collides.

Trait Implementations§

Source§

impl Clone for MetadataChangesParams

Source§

fn clone(&self) -> Self

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 Debug for MetadataChangesParams

Source§

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

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

impl Default for MetadataChangesParams

Source§

fn default() -> Self

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

impl Serialize for MetadataChangesParams

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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<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: Sized + 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: Sized + 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 = !

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

fn try_from(value: U) -> Result<T, !>

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