Skip to main content

CidCapability

Struct CidCapability 

Source
#[non_exhaustive]
pub struct CidCapability { pub extra: Map<String, Value>, }
Expand description

Value object of the urn:ietf:params:jmap:cid capability (draft-atwood-jmap-cid-00 §3).

The draft currently specifies an empty value object: when a server advertises CID, the value of the JMAP_CID_URI key in both the session-level capabilities object and per-account accountCapabilities is {}. The #[non_exhaustive] attribute keeps the door open for the draft to add capability-level fields (e.g. an enumerated digest algorithm set when CID generalises beyond SHA-256) without a breaking change to consumers that destructure the struct.

The extra field is the workspace extras-preservation surface (workspace AGENTS.md “extras-preservation policy”): unknown vendor / site / future IETF fields on the wire JSON survive deserialize and serialize untouched.

§Example

use jmap_cid_types::CidCapability;

// Empty value object per the current draft revision.
let cap: CidCapability = serde_json::from_str("{}")?;
assert!(cap.extra.is_empty());

// Vendor extension survives round-trip.
let cap: CidCapability = serde_json::from_str(
    r#"{"acmeCorpFastDigest": true}"#,
)?;
assert_eq!(
    cap.extra.get("acmeCorpFastDigest"),
    Some(&serde_json::Value::Bool(true)),
);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§extra: Map<String, Value>

Catch-all for vendor / site / future-IETF fields not covered by the typed fields above. Preserves unknown fields across deserialize/serialize round-trip per workspace policy.

Trait Implementations§

Source§

impl Clone for CidCapability

Source§

fn clone(&self) -> CidCapability

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 CidCapability

Source§

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

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

impl Default for CidCapability

Source§

fn default() -> CidCapability

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

impl<'de> Deserialize<'de> for CidCapability

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 PartialEq for CidCapability

Source§

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

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 StructuralPartialEq for CidCapability

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

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.