Type Alias vstorage::Href

source ·
pub type Href = String;
Expand description

The path to the item inside the collection.

For example, for carddav collections this is the path of the entry inside the collection. For vdir::VdirStorage, this the file’s relative path, etc. Hrefs MUST be valid UTF-8 sequences. Implementations MUST define their Href in a way that it is possible to infer:

  • Whether an Href belongs to a collection or an item.
  • For an item, to which collection it belongs.

Whether an href is relative to a collection or absolute is storage dependant. As such, this should be treated as an opaque string by consumers of this library.

Aliased Type§

struct Href { /* private fields */ }