Struct vstorage::base::VcardItem

pub struct VcardItem { /* private fields */ }

Immutable wrapper around a VCARD.

Note that this is not a proper validating parser for vcard; it’s a very simple one with the sole purpose of extracing a UID. Proper parsing of components is out of scope, since we want to enable operating on potentially invalid items too.

Trait Implementations

impl Debug for VcardItem

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

Formats the value using the given formatter.

impl From<String> for VcardItem

fn from(value: String) -> Self

Converts to this type from the input type.

impl Item for VcardItem

fn uid(&self) -> Option<String>

Returns a unique identifier for this item.

The UID does not change when the item is modified. The UID must remain the same when the item is copied across storages and storage types.

fn hash(&self) -> String

Returns the hash of the normalised content.

fn ident(&self) -> String

A unique identifier for this item. Is either the UID (if any), or the hash of its contents.

fn with_uid(&self, new_uid: &str) -> Self

Returns a new copy of this Item with the supplied UID.

fn as_str(&self) -> &str

Returns the raw contents of this item.

type Property = AddressBookProperty

Property types supported by storages.

impl<C> Storage<VcardItem> for CardDavStorage<C>

where C: Connect + Clone + Sync + Send,

fn discover_collections<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Discovery, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Finds existing collections for this storage.

Will only return collections stored under the principal’s home set. In most common scenarios, this implies that only collections owned by the current user are found and not other collections.

Collections outside the principal’s home set can be referenced by using an absolute path.

fn destroy_collection<'life0, 'life1, 'async_trait>( &'life0 self, href: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deletes a carddav collection.

This method does multiple network calls to ensure that the collection is empty. If the server property supports Etag (it MUST as per the spec), this method guarantees that the collection is empty when deleting it.

If the server is not compliant and does not support Etags, possible race conditions could occur and if contacts components are added to the collection concurrently, they may be deleted.

fn set_property<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, href: &'life1 str, prop: AddressBookProperty, value: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Errors

Only DisplayName is implemented.

fn unset_property<'life0, 'life1, 'async_trait>( &'life0 self, href: &'life1 str, prop: AddressBookProperty, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Errors

Only DisplayName is implemented.

fn get_property<'life0, 'life1, 'async_trait>( &'life0 self, href: &'life1 str, prop: AddressBookProperty, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read metadata from a collection.

Metadata is fetched using the PROPFIND method under the hood. Some servers may not support some properties.

Errors

If the underlying HTTP connection fails or if the server returns invalid data.

Only DisplayName is implemented.

fn collection_id(&self, collection_href: &str) -> Result<CollectionId, Error>

The collection_id of a carddav collection is the last component of the path.

fn href_for_collection_id(&self, id: &CollectionId) -> Result<Href, Error>

Errors

Returns ErrorKind::PreconditionFailed if a home set was not found in the carddav server.

fn check<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Checks that the storage works. This includes validating credentials, and reachability.

fn create_collection<'life0, 'life1, 'async_trait>( &'life0 self, href: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Collection, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates a new collection with a specified href.

fn list_items<'life0, 'life1, 'async_trait>( &'life0 self, collection_href: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ItemRef>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Enumerates items in a given collection.

fn get_item<'life0, 'life1, 'async_trait>( &'life0 self, href: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(VcardItem, Etag), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetches a single item from given collection.

fn get_many_items<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, hrefs: &'life1 [&'life2 str], ) -> Pin<Box<dyn Future<Output = Result<Vec<FetchedItem<VcardItem>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetches multiple items.

fn get_all_items<'life0, 'life1, 'async_trait>( &'life0 self, collection_href: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<FetchedItem<VcardItem>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch all items from a given collection.

fn add_item<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, collection_href: &'life1 str, item: &'life2 VcardItem, ) -> Pin<Box<dyn Future<Output = Result<ItemRef, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Saves a new item into a given collection

fn update_item<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, href: &'life1 str, etag: &'life2 Etag, item: &'life3 VcardItem, ) -> Pin<Box<dyn Future<Output = Result<Etag, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Updates the contents of an existing item.

fn delete_item<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, href: &'life1 str, etag: &'life2 Etag, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Deletes an existing item.

fn list_properties<'life0, 'life1, 'async_trait>( &'life0 self, collection_href: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ListedProperty<AddressBookProperty>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List all properties of a collection.

fn monitor<'life0, 'async_trait>( &'life0 self, bufsize: NonZeroUsize, ) -> Pin<Box<dyn Future<Output = Result<Receiver<Event>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Monitor the storage for changes.