Enum imap::extensions::metadata::MetadataDepth

pub enum MetadataDepth {
    Zero,
    One,
    Infinity,
}

Represents variants of the DEPTH parameter for the GETMETADATA command.

When a non-zero depth is specified with the GETMETADATA command, it extends the list of entry values returned by the server. For each entry name specified in the GETMETADATA command, the server returns the value of the specified entry name (if it exists), plus all entries below the entry name up to the specified DEPTH.

See also RFC 5464, section 4.2.2.

Variants

Zero

No entries below the specified entry are returned.

One

Only entries immediately below the specified entry are returned.

Thus, a depth of one for an entry /a will match /a as well as its children entries (e.g., /a/b), but will not match grandchildren entries (e.g., /a/b/c).

Infinity

All entries below the specified entry are returned

Trait Implementations

impl Clone for MetadataDepth

fn clone(&self) -> MetadataDepth

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataDepth

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

Formats the value using the given formatter.

impl Default for MetadataDepth

fn default() -> Self

Returns the “default value” for a type.

impl Copy for MetadataDepth