Enum Metadata 

#[non_exhaustive]
pub enum Metadata {
    Annotation(Annotation),
    ImapMetadata(ImapMetadata),
    WebDavMetadata(WebDavMetadata),
}

A JMAP Metadata object (draft-ietf-jmap-metadata-01 §2).

The spec defines three concrete object types — Annotation, ImapMetadata, and WebDavMetadata — all discriminated by the @type property. This enum is serialised with @type as the internal tag, matching the wire format defined by §2.1.

Additional metadata types MAY be defined by future specifications (§2.1). Such future types will require new variants on this enum; the #[non_exhaustive] derive keeps that non-breaking.

Wire-format examples

{ "@type": "Annotation", "id": "MD1", "relatedType": "Mailbox",
  "relatedId": "MB1", "isPrivate": true,
  "acme.example.com:color": "blue" }

{ "@type": "ImapMetadata", "id": "MD2", "relatedType": "Mailbox",
  "relatedId": "MB1", "isPrivate": false,
  "metadata": { "comment": "Team mailbox" } }

{ "@type": "WebDavMetadata", "id": "MD3", "relatedType": "FileNode",
  "relatedId": "F1", "isPrivate": false,
  "metadata": { "{DAV:}displayname": "Project Documents" } }

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Annotation(Annotation)

General-purpose vendor metadata (draft-ietf-jmap-metadata-01 §2.1.1).

ImapMetadata(ImapMetadata)

IMAP RFC 5464 mapping (draft-ietf-jmap-metadata-01 §2.1.2).

WebDavMetadata(WebDavMetadata)

WebDAV RFC 4918 dead-property mapping (draft-ietf-jmap-metadata-01 §2.1.3).

Implementations

impl Metadata

pub fn id(&self) -> Option<&Id>

Return the id property common to every Metadata variant.

pub fn related_type(&self) -> Option<&str>

Return the relatedType property common to every Metadata variant, or None if the wire input omitted it.

The spec marks relatedType mandatory for full Metadata objects per §2.2.1.3, but the /get partial-response shape defined by §4.1 legitimately omits it: §4.1 lists only @type and relatedId as the properties a server MUST always include, regardless of the caller’s metadataProperties filter. The §7.2 example response demonstrates this wire shape. This accessor therefore returns Option<&str>. Callers that have a complete Metadata record (created via Metadata/set) can .expect() here; callers consuming partial responses from extended-/get should handle the None arm — typically by inferring the type from the related-object context.

pub fn related_id(&self) -> &Id

Return the relatedId property common to every Metadata variant.

pub fn is_private(&self) -> bool

Return the isPrivate property common to every Metadata variant (defaulting to false per §2.2.1.5 when the inner field is None).

pub fn type_name(&self) -> &'static str

Return the wire string for the @type discriminator.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GetObject for Metadata

impl JmapObject for Metadata

const TYPE_NAME: &'static str = "Metadata"

The JMAP type name string (e.g. "Email", "Mailbox", "Chat").

type Property = MetadataProperty

The property selector enum for this type (server-side only, no serde).

impl PartialEq for Metadata

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl QueryObject for Metadata

type Filter = MetadataFilterCondition

The filter condition type.

type Comparator = Value

The comparator type for sort operations.

impl Serialize for Metadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SetObject for Metadata

type Patch = PatchObject

The patch type for update operations.

impl StructuralPartialEq for Metadata