Skip to main content

Metadata

Enum Metadata 

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

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

This enum is marked as 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§

Source§

impl Metadata

Source

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

Return the id property common to every Metadata variant.

Source

pub fn related_type(&self) -> &str

Return the relatedType property common to every Metadata variant.

Source

pub fn related_id(&self) -> &Id

Return the relatedId property common to every Metadata variant.

Source

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).

Source

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

Return the wire string for the @type discriminator.

Trait Implementations§

Source§

impl Clone for Metadata

Source§

fn clone(&self) -> Metadata

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 Metadata

Source§

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

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

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

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 JmapObject for Metadata

Source§

const TYPE_NAME: &'static str = "Metadata"

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

type Property = MetadataProperty

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

impl PartialEq for Metadata

Source§

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

Source§

type Filter = MetadataFilterCondition

The filter condition type. Read more
Source§

type Comparator = Value

The comparator type for sort operations.
Source§

impl Serialize for Metadata

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 SetObject for Metadata

Source§

type Patch = PatchObject

The patch type for update operations. Read more
Source§

impl GetObject for Metadata

Source§

impl StructuralPartialEq for Metadata

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, 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>,