Struct vstorage::base::Collection

pub struct Collection { /* private fields */ }

A collection may, for example, be an address book or a calendar.

The type of items contained is restricted by the underlying implementation. Collections contain zero or more items (e.g.: an address book contains events). Each item is addressed by its own Href.

This type wraps around the href for a collection on a given storage. Using the same Collection instance across different storages is disallowed.

Implementations

impl Collection

pub fn href(&self) -> &Href

The path to this collection inside the storage.

Href should not change over time, so should be associated with an immutable property of the collection (e.g.: a relative URL path, or a directory’s filename).

The exact meaning of this value is storage-specific, but should be remain consistent with a storage.

pub fn into_href(self) -> Href

Trait Implementations

impl Debug for Collection

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

Formats the value using the given formatter.