Enum NodeRole 

#[non_exhaustive]
pub enum NodeRole {
    Root,
    Home,
    Temp,
    Trash,
    Documents,
    Downloads,
    Music,
    Pictures,
    Videos,
    Other(String),
}

Special role identifying a directory’s common purpose (draft-ietf-jmap-filenode-13 §3.1, IANA “JMAP FileNode Roles” registry §10.5).

Clients MUST ignore unrecognised role values (§3.1). Unknown values are preserved as NodeRole::Other so they round-trip correctly.

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.

Root

Base of a filesystem; should have parentId null.

Home

User’s home directory.

Temp

Temporary space; may be cleaned up automatically.

Trash

Deleted data.

Documents

Document storage.

Downloads

Downloaded files.

Music

Audio files.

Pictures

Photos and images.

Videos

Video files.

Other(String)

Any role string not recognised by this implementation.

Implementations

impl NodeRole

pub fn to_wire_str(&self) -> &str

Return the wire-format string for this role.

Trait Implementations

impl Clone for NodeRole

fn clone(&self) -> NodeRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeRole

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeRole

fn deserialize<D: Deserializer<'de>>(d: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for NodeRole

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

Formats the value using the given formatter.

impl Eq for NodeRole

impl Hash for NodeRole

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NodeRole

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NodeRole

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NodeRole