Struct vstorage::CollectionId

pub struct CollectionId { /* private fields */ }

An identifier for a collection.

Collection identifiers are a short string that uniquely identify a collection inside a storage. They are based on the href of a collection, which never changes. The CollectionId is intended as a more human-friendly substitute for collection hrefs.

The following limitations exist, given that such values would produce ambiguous results with the implementation of VdirStorage, CalDavStorage, and CardDavStorage:

• A CollectionId cannot contain a / (slash)
• A CollectionId cannot be exactly .. (double period).
• A CollectionId cannot be exactly . (a single period).

Creating instances

Instances of CollectionId always contain previously validated data.

See: CollectionId::try_from and CollectionId::from_str.

Trait Implementations

impl AsRef<str> for CollectionId

fn as_ref(&self) -> &str

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

impl Clone for CollectionId

fn clone(&self) -> CollectionId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionId

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

Formats the value using the given formatter.

impl Display for CollectionId

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

Formats the value using the given formatter.

impl From<CollectionId> for String

fn from(value: CollectionId) -> String

Converts to this type from the input type.

impl FromStr for CollectionId

fn from_str(s: &str) -> Result<Self, Self::Err>

Creates a new CollectionId with the input data.

When converting a String, use CollectionId::try_from instead to avoid re-allocating the string data.

Example

let collection_id: CollectionId = "personal".parse().unwrap();

type Err = CollectionIdError

The associated error which can be returned from parsing.

impl Hash for CollectionId

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 CollectionId

fn eq(&self, other: &CollectionId) -> 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 TryFrom<String> for CollectionId

fn try_from(value: String) -> Result<Self, Self::Error>

Converts a String instance into a CollectionId.

Note that manually allocating a String before calling this method is an anti-pattern; the cost of the re-allocation is paid even if the validation fails. For converting &str, see CollectionId::from_str.

type Error = CollectionIdError

The type returned in the event of a conversion error.

impl Eq for CollectionId

impl StructuralPartialEq for CollectionId