Struct VdirCollection 

pub struct VdirCollection {
    pub path: VdirPath,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub color: Option<String>,
}

A Vdir collection.

Represents a directory that contains only items (vCard or iCalendar files). A collection may also carry the optional metadata files defined by the vdir specification.

See crate::item::VdirItem.

Fields

path: VdirPath

On-disk directory of the collection.

display_name: Option<String>

Display name of the collection, when the displayname file exists and is non-empty.

description: Option<String>

Description of the collection, when the description file exists and is non-empty.

color: Option<String>

ASCII #RRGGBB hex color of the collection, when the color file exists and is non-empty.

Implementations

impl VdirCollection

pub fn from_path(path: impl Into<VdirPath>) -> Self

Wraps path as a bare collection with no metadata. Performs no filesystem check.

pub fn id(&self) -> &str

Returns the collection id: the final path component, or an empty string when the path has no file name.

Trait Implementations

impl AsRef<VdirPath> for VdirCollection

fn as_ref(&self) -> &VdirPath

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for VdirCollection

fn clone(&self) -> VdirCollection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VdirCollection

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

Formats the value using the given formatter.

impl Default for VdirCollection

fn default() -> VdirCollection

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VdirCollection

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for VdirCollection

impl From<VdirPath> for VdirCollection

fn from(path: VdirPath) -> Self

Converts to this type from the input type.

impl Hash for VdirCollection

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 Ord for VdirCollection

fn cmp(&self, other: &VdirCollection) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VdirCollection

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VdirCollection

fn partial_cmp(&self, other: &VdirCollection) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for VdirCollection

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VdirCollection