Skip to main content

Argument

Enum Argument 

Source
pub enum Argument<T: Sealed> {
    Value(T),
    Ref(ResultReference),
}
Expand description

A JMAP method argument that can be either a direct value or a ResultReference.

In JMAP JSON, a ResultReference is indicated by a “#” prefix on the key: "ids": [...] → Argument::Value([…]) "#ids": {...} → Argument::Ref(ResultReference { … })

The resolver in kith-jmap evaluates Ref variants before method dispatch.

§Deserialization note

Uses #[serde(untagged)] which tries to deserialize as T first. If T and ResultReference share field names, T is preferred. Callers must handle the # key prefix before deserializing.

§Invariant

T must not deserialize from a JSON object with keys resultOf, name, and path. If T accepts arbitrary JSON objects, #[serde(untagged)] will match T before trying Ref, silently swallowing any ResultReference payload. The sealed set is chosen specifically to exclude struct types for this reason. Never implement Sealed for a type that deserializes from a JSON object.

§Type safety

T is constrained to sealed::Sealed types. serde_json::Value does NOT implement SealedArgument<Value> therefore fails to compile. This prevents a silent bug: Value accepts any JSON, so with T = Value the Ref variant can never be reached via serde; every ResultReference JSON would deserialize as Argument::Value(json_object) and the reference would be silently ignored.

use jmap_types::resultref::Argument;
// serde_json::Value does not implement Sealed — this must not compile.
let _: Argument<serde_json::Value> = Argument::Value(serde_json::Value::Null);

Variants§

§

Value(T)

A direct, inlined argument value supplied by the caller.

§

Ref(ResultReference)

A result-reference back to a previous method response in the same request (RFC 8620 §3.7), resolved by the dispatcher before invoking the method handler.

Trait Implementations§

Source§

impl<T: Clone + Sealed> Clone for Argument<T>

Source§

fn clone(&self) -> Argument<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 + Sealed> Debug for Argument<T>

Source§

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

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

impl<'de, T> Deserialize<'de> for Argument<T>
where T: Deserialize<'de> + Sealed,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

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

impl<T: Hash + Sealed> Hash for Argument<T>

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<T: PartialEq + Sealed> PartialEq for Argument<T>

Source§

fn eq(&self, other: &Argument<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 for Argument<T>
where T: Serialize + Sealed,

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
Source§

impl<T: Eq + Sealed> Eq for Argument<T>

Source§

impl<T: Sealed> StructuralPartialEq for Argument<T>

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for Argument<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<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,