[−][src]Struct etebase::Collection
A collection of items
Like Items, collections have two pieces of data associated with them:
- metadata - contains meta information like name and modification time
- Content - a buffer containing arbitrary binary data They also have an immutable type and an associated sync token
Implementations
impl Collection
[src]
pub fn verify(&self) -> Result<bool>
[src]
Manually verify the integrity of the collection
This is also done automatically by the API
pub fn set_meta<T: MsgPackSerilization>(&mut self, meta: &T) -> Result<()>
[src]
Set metadata for the collection object
Arguments:
meta
- the ItemMetadata object to be set for the collection
pub fn meta(&self) -> Result<ItemMetadata>
[src]
Return the ItemMetadata of the collection
pub fn meta_generic<T: MsgPackSerilization>(&self) -> Result<T::Output>
[src]
Return the ItemMetadata of the collection deserializing using a generic metadata object
The metadata object needs to implement the MsgPackSerilization trait.
pub fn set_meta_raw(&mut self, meta: &[u8]) -> Result<()>
[src]
Set metadata for the collection object from a byte array
Arguments:
meta
- the metadata for the collection. This needs to be a valid ItemMetadata struct encoded usingmsgpack
.
pub fn meta_raw(&self) -> Result<Vec<u8>>
[src]
Return metadata for the collection object as a byte array
pub fn set_content(&mut self, content: &[u8]) -> Result<()>
[src]
Set the content of the collection
Arguments:
content
- the content of the collection as a byte array
pub fn content(&self) -> Result<Vec<u8>>
[src]
Return the content of the collection as a byte array
pub fn delete(&mut self) -> Result<()>
[src]
Mark the collection as deleted
The collection needs to be uploaded for this to take effect
pub fn is_deleted(&self) -> bool
[src]
Check whether the collection is marked as deleted
pub fn uid(&self) -> &str
[src]
The UID of the collection
pub fn etag(&self) -> &str
[src]
The etag of the collection
pub fn stoken(&self) -> Option<&str>
[src]
The sync token for the collection
The sync token reflects changes to the collection properties or its Items on the server
pub fn access_level(&self) -> CollectionAccessLevel
[src]
Return the access level of the collection for the current user
pub fn item(&self) -> Result<Item>
[src]
Return the collection as an Item
pub fn collection_type(&self) -> Result<String>
[src]
The type of the collection
Trait Implementations
impl Clone for Collection
[src]
pub fn clone(&self) -> Collection
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
Auto Trait Implementations
impl !RefUnwindSafe for Collection
[src]
impl Send for Collection
[src]
impl !Sync for Collection
[src]
impl Unpin for Collection
[src]
impl UnwindSafe for Collection
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,