Struct etebase::Item

pub struct Item { /* private fields */ }

Items belong to collections and are where data is stored

Items have two pieces of data associated with them:

• metadata - contains meta information like name and modification time
• Content - a buffer containing arbitrary binary data.

Implementations

impl Item

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

Manually verify the integrity of the item

This is usually done automatically by the API

pub fn set_meta<T: MsgPackSerilization>(&mut self, meta: &T) -> Result<()>

Set metadata for the item object

Arguments:

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

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

Return the ItemMetadata of the item

Examples found in repository

examples/etebase_test.rs (line 18)

fn print_item(item: &Item) {
    println!("UID: {}", &item.uid());
    println!("Meta: {:?}", &item.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 item object from a byte array

Arguments:

• meta - the metadata for the item. This needs to be a valid ItemMetadata struct encoded using msgpack.

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

Return metadata for the item object as a byte array

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

Set the content of the item

Arguments:

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

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

Return the content of the item as a byte array

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

Mark the item as deleted

The item needs to be uploaded for this to take effect

pub fn is_deleted(&self) -> bool

Check whether the item is marked as deleted

pub fn is_missing_content(&self) -> bool

Check whether the item is missing content and should be downloaded

If it is, the content should be downloaded with ItemManager::download_content.

pub fn uid(&self) -> &str

The UID of the item

Examples found in repository

examples/etebase_test.rs (line 17)

fn print_item(item: &Item) {
    println!("UID: {}", &item.uid());
    println!("Meta: {:?}", &item.meta().unwrap());
    println!();
}

pub fn etag(&self) -> &str

The etag of the item

Trait Implementations

impl Clone for Item

fn clone(&self) -> Item

Returns a copy of the value.

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

Performs copy-assignment from source.