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<C> Definition<VcardItem> for CardDavDefinition<C>where C: Connect + Send + Sync + Clone + 'static + Debug,

fn build_boxed<'async_trait>( self ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Storage<VcardItem>>, Error>> + Send + 'async_trait>>where Self: 'async_trait,

Returns a new storage instance wrapped in a box.

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 raw content.

This is used as a fallback when a storage backend doesn’t provide Etag values, or when an item is missing its UID.

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.

Panics

This function is not yet implemented.

fn as_str(&self) -> &str

Returns the raw contents of this item.

type CollectionProperty = 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<Vec<Collection>, 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. 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 can still be found by providing an absolute path to CardDavStorage::open_collection.

fn create_collection_with_id<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 CollectionId ) -> Pin<Box<dyn Future<Output = Result<Collection, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a new address book such that its collection_id matches the given input.

Errors

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

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 address book components are added to the collection at the same time, they may be deleted.

fn set_collection_property<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, collection: &'life1 Collection, meta: 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,

Panics

Only DisplayName is implemented.

fn get_collection_property<'life0, 'life1, 'async_trait>( &'life0 self, collection: &'life1 Collection, meta: 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.

Panics

Only DisplayName is implemented.

fn collection_id(&self, collection: &Collection) -> Result<CollectionId, Error>

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

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 open_collection(&self, href: &str) -> Result<Collection, Error>

Open an existing collection.

fn list_items<'life0, 'life1, 'async_trait>( &'life0 self, collection: &'life1 Collection ) -> 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, 'life2, 'async_trait>( &'life0 self, collection: &'life1 Collection, href: &'life2 str ) -> Pin<Box<dyn Future<Output = Result<(VcardItem, Etag), Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Fetches a single item from given collection.

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

Fetches multiple items.

fn get_all_items<'life0, 'life1, 'async_trait>( &'life0 self, collection: &'life1 Collection ) -> Pin<Box<dyn Future<Output = Result<Vec<(Href, VcardItem, Etag)>, 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: &'life1 Collection, 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, 'life4, 'async_trait>( &'life0 self, _collection: &'life1 Collection, href: &'life2 str, etag: &'life3 Etag, item: &'life4 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, 'life4: 'async_trait,

Updates an existing item in a given collection.

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