Struct IcsItem

pub struct IcsItem { /* private fields */ }

Immutable wrapper around a VCALENDAR or VCARD.

Note that this is not a proper validating parser for icalendar or vcard; it’s a very simple one with the sole purpose of extracing a UID. Proper parsing of components is out of scope, since supporting potentially invalid items is required.

Trait Implementations

impl Clone for IcsItem

fn clone(&self) -> IcsItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IcsItem

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

Formats the value using the given formatter.

impl From<String> for IcsItem

fn from(value: String) -> Self

Creates a new instance from valid iCalendar data.

impl Item for IcsItem

type Property = CalendarProperty

Calendar properties defined by CalDav.

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

Returns the contents of the UID property, if defined.

fn hash(&self) -> String

Returns the hash of the normalised content.

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.

fn ident(&self) -> String

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

impl<C> Storage<IcsItem> for CalDavStorage<C>

where C: Service<Request<String>, Response = Response<Incoming>> + Send + Sync + 'static, C::Error: Error + Send + Sync, C::Future: Send + Sync,

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

fn set_property<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, href: &'life1 str, prop: CalendarProperty, 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 and Colour are implemented.

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

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

Errors

Only DisplayName and Colour are implemented.

fn get_property<'life0, 'life1, 'async_trait>( &'life0 self, href: &'life1 str, prop: CalendarProperty, ) -> 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 and Colour are implemented.

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<(IcsItem, 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<IcsItem>>, 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: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<FetchedItem<IcsItem>>, 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 IcsItem, ) -> 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 IcsItem, ) -> 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<CalendarProperty>>, 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.

impl<C> Storage<IcsItem> for WebCalStorage<C>

where C: Service<Request<String>, Response = Response<Incoming>> + Send + Sync + Clone + 'static, C::Error: Error + Send + Sync, C::Future: Send + Sync,

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 remove resource exists and whether it looks like an icalendar resource.

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,

Returns a single collection with the name originally specified.

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

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

Unsupported for this storage type.

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

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

Unsupported for this storage type.

fn list_items<'life0, 'life1, 'async_trait>( &'life0 self, _collection: &'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 this collection.

Note that, due to the nature of webcal, the whole collection needs to be retrieved. If some items need to be read as well, it is generally best to use WebCalStorage::get_all_items instead.

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

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

Returns a single item from the collection.

Note that, due to the nature of webcal, the whole collection needs to be retrieved. It is strongly recommended to use WebCalStorage::get_all_items instead.

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

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

Returns multiple items from the collection.

Note that, due to the nature of webcal, the whole collection needs to be retrieved. It is generally best to use WebCalStorage::get_all_items instead.

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

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

Fetch all items in the collection.

Performs a single HTTP(s) request to fetch all items.

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

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

Unsupported for this storage type.

fn update_item<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _: &'life1 str, _: &'life2 Etag, _: &'life3 IcsItem, ) -> 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,

Unsupported for this storage type.

fn set_property<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _: &'life1 str, __arg2: CalendarProperty, _: &'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,

Unsupported for this storage type.

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

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

Unsupported for this storage type.

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

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

Unsupported for this storage type.

fn delete_item<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _: &'life1 str, _: &'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 href_for_collection_id(&self, id: &CollectionId) -> Result<Href, Error>

Return the href for a collection that is expected to have id.

fn list_properties<'life0, 'life1, 'async_trait>( &'life0 self, _: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ListedProperty<CalendarProperty>>, 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.