Struct etebase::Collection

pub struct Collection { /* private fields */ }

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

pub fn verify(&self) -> Result<bool>

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<()>

Set metadata for the collection object

Arguments:

• meta - the ItemMetadata object to be set for the collection

pub fn meta(&self) -> Result<ItemMetadata>

Return the ItemMetadata of the collection

Examples found in repository

examples/etebase_test.rs (line 12)

fn print_collection(collection: &Collection) {
    println!("UID: {}", &collection.uid());
    println!("Meta: {:?}", &collection.meta().unwrap());
    println!();
}

pub fn meta_generic<T: MsgPackSerilization>(&self) -> Result<T::Output>

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<()>

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 using msgpack.

pub fn meta_raw(&self) -> Result<Vec<u8>>

Return metadata for the collection object as a byte array

pub fn set_content(&mut self, content: &[u8]) -> Result<()>

Set the content of the collection

Arguments:

• content - the content of the collection as a byte array

pub fn content(&self) -> Result<Vec<u8>>

Return the content of the collection as a byte array

pub fn delete(&mut self) -> Result<()>

Mark the collection as deleted

The collection needs to be uploaded for this to take effect

pub fn is_deleted(&self) -> bool

Check whether the collection is marked as deleted

pub fn uid(&self) -> &str

The UID of the collection

Examples found in repository

examples/etebase_test.rs (line 11)

fn print_collection(collection: &Collection) {
    println!("UID: {}", &collection.uid());
    println!("Meta: {:?}", &collection.meta().unwrap());
    println!();
}

pub fn etag(&self) -> &str

The etag of the collection

pub fn stoken(&self) -> Option<&str>

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

Return the access level of the collection for the current user

pub fn item(&self) -> Result<Item>

Return the collection as an Item

pub fn collection_type(&self) -> Result<String>

The type of the collection

Trait Implementations

impl Clone for Collection

fn clone(&self) -> Collection

Returns a copy of the value.

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

Performs copy-assignment from source.