Struct zotero::Zotero

pub struct Zotero<'a> {
    pub library_type: LibraryType<'a>,
}

A struct representing a Zotero client.

Fields

library_type: LibraryType<'a>

Trait Implementations

impl<'a> Delete<'a> for Zotero<'a>

fn delete_request(
    &self,
    params: &str,
    last_version: &str
) -> Result<Value, Box<dyn Error>>

fn get_id(&self) -> &'a str

fn delete_item<S: AsRef<str> + Display>(
    &self,
    item_key: S,
    last_version: S
) -> Result<Value, Box<dyn Error>>

Delete a Zotero item. no_run # use zotero::ZoteroInit; # use zotero::Delete; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); z.delete_item("PJTUB2WE", "2050");

fn delete_items<S: AsRef<str> + Display>(
    &self,
    items_keys: Vec<S>,
    last_version: S
) -> Result<Value, Box<dyn Error>>

Delete a Zotero item. no_run # use zotero::ZoteroInit; # use zotero::Delete; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); z.delete_items(vec!["PJTUB2WE", "YXT5PJU9"], "2050");

fn delete_collection<S: AsRef<str> + Display>(
    &self,
    item_key: S,
    last_version: S
) -> Result<Value, Box<dyn Error>>

Delete a Zotero collection. no_run # use zotero::ZoteroInit; # use zotero::Delete; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); z.delete_collection("TYQDGEZR", "2050");

fn delete_search<S: AsRef<str> + Display>(
    &self,
    search_key: S,
    last_version: S
) -> Result<Value, Box<dyn Error>>

Delete a Zotero search.

fn delete_tag<S: AsRef<str> + Display>(
    &self,
    tag_key: S,
    last_version: S
) -> Result<Value, Box<dyn Error>>

Delete a Zotero tag. no_run # use zotero::ZoteroInit; # use zotero::Delete; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); z.delete_tag("history", "2050");

fn delete_tags<S: AsRef<str> + Display>(
    &self,
    tags_keys: Vec<S>,
    last_version: S
) -> Result<Value, Box<dyn Error>>

Delete multiple Zotero tags. no_run # use zotero::ZoteroInit; # use zotero::Delete; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); z.delete_tags(vec!["history", "philosophy", "art"], "2050");

impl<'a> Get<'a> for Zotero<'a>

fn get_request<S: AsRef<str> + Display>(
    &self,
    params: S,
    extra_params: Option<&str>
) -> Result<Value, Box<dyn Error>>

fn get_id(&self) -> &'a str

fn get_api_key(&self) -> &'a str

fn get_api_key_info<I: Into<Option<&'a str>>>(
    &self,
    extra_params: I
) -> Result<Value, Box<dyn Error>>

Retreive information about an api key and it's privileges. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let collection = z.get_api_key_info("bZARysJ579K5SdmYuaAJ");

fn get_item<I: Into<Option<&'a str>>>(
    &self,
    item_id: &'a str,
    extra_params: I
) -> Result<Item, Box<dyn Error>>

Retreive specific item in the library by it's ID. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let items = z.get_item("B8ZNE3GH", None);

fn get_items<I: Into<Option<&'a str>>>(
    &self,
    extra_params: I
) -> Result<Vec<Item>, Box<dyn Error>>

Retreive all items in the library, excluding trashed items. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let items = z.get_items(None);

fn get_top_items<I: Into<Option<&'a str>>>(
    &self,
    extra_params: I
) -> Result<Vec<Item>, Box<dyn Error>>

Retreive top-level items in the library, excluding trashed items. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let top_items = z.get_top_items(None);

fn get_trashed_items<I: Into<Option<&'a str>>>(
    &self,
    extra_params: I
) -> Result<Vec<Item>, Box<dyn Error>>

Retreive items in the trash. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let trashed_items = z.get_trashed_items(None);

fn get_publications<I: Into<Option<&'a str>>>(
    &self,
    extra_params: I
) -> Result<Vec<Item>, Box<dyn Error>>

Retreive items in "My publications". no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let my_publications = z.get_publications(None);

fn get_collection<I: Into<Option<&'a str>>>(
    &self,
    collection_id: &'a str,
    extra_params: I
) -> Result<Collection, Box<dyn Error>>

Retreive a collection by it's id. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let collection = z.get_collection("AYVWED", None);

fn get_collection_by_name<I: Into<Option<&'a str>>>(
    &self,
    collection_name: &'a str,
    extra_params: I
) -> Result<Option<Collection>, Box<dyn Error>>

Retreive a collection by it's name. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let collection = z.get_collection_by_name("My collection", None);

fn get_collections_by_names<I: Into<Option<&'a str>>>(
    &self,
    collection_names: Vec<&'a str>,
    extra_params: I
) -> Result<Option<Vec<Collection>>, Box<dyn Error>>

Retreive a set of collections by their names. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let collections = z.get_collections_by_names(vec!("My collection", "My other collection"), None);

fn get_collections<I: Into<Option<&'a str>>>(
    &self,
    extra_params: I
) -> Result<Vec<Collection>, Box<dyn Error>>

Retreive all collections. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let collections = z.get_collections(None);

fn get_top_collections<I: Into<Option<&'a str>>>(
    &self,
    extra_params: I
) -> Result<Vec<Collection>, Box<dyn Error>>

Retreive top level collections. no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let top_collections = z.get_top_collections(None);

fn get_collection_items<I: Into<Option<&'a str>>>(
    &self,
    collection_id: &'a str,
    extra_params: I
) -> Result<Vec<Item>, Box<dyn Error>>

Retreive all items for a given collection no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let collection_items = z.get_collection_items("AYVWED", None);

fn get_collection_top_items<I: Into<Option<&'a str>>>(
    &self,
    collection_id: &'a str,
    item_id: &'a str,
    extra_params: I
) -> Result<Vec<Item>, Box<dyn Error>>

Retreive top-level items for a given collection no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let collection_top_items = z.get_collection_top_items("AYVWED", "B8ZNE3GH", None);

fn get_subset<I: Into<Option<&'a str>>>(
    &self,
    item_ids: Vec<&'a str>,
    extra_params: I
) -> Result<Vec<Item>, Box<dyn Error>>

Retreive up to 50 items by their ids no_run # use zotero::ZoteroInit; # use zotero::Get; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let items = z.get_subset(vec!("AYVWED", "B8ZNE3GH"), None);

impl<'a> Patch<'a> for Zotero<'a>

fn patch_request<T: Serialize>(
    &self,
    params: &str,
    json_body: T
) -> Result<Value, Box<dyn Error>>

fn get_id(&self) -> &'a str

fn update_item<T: Serialize, S: AsRef<str> + Display>(
    &self,
    item_key: S,
    item_data: T
) -> Result<Value, Box<dyn Error>>

Update a zotero item. ```no_run # use zotero::ZoteroInit; # use zotero::Patch; # use zotero::Get; # use zotero::data_structure::item::ItemType; let z = ZoteroInit::set_user("123456789", "bZARysJ579K5SdmYuaAJ"); let remote_item = z.get_item("B8ZNE3GH", None);

impl<'a> Post<'a> for Zotero<'a>

fn post_request<T: Serialize, S: AsRef<str> + Display>(
    &self,
    params: S,
    json_body: T
) -> Result<Value, Box<dyn Error>>

fn get_id(&self) -> &'a str

fn create_new_item<T: Serialize>(
    &self,
    item: T
) -> Result<Value, Box<dyn Error>>

fn create_new_items<T: Serialize>(
    &self,
    item: Vec<T>
) -> Result<Value, Box<dyn Error>>

Create multiple items

fn create_new_collection<T: Serialize>(
    &self,
    item: T
) -> Result<Value, Box<dyn Error>>

Create new collection

fn create_new_collections<T: Serialize>(
    &self,
    item: Vec<T>
) -> Result<Value, Box<dyn Error>>

Create new collections

impl<'a> PartialEq<Zotero<'a>> for Zotero<'a>

fn eq(&self, other: &Zotero<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Zotero<'a>) -> bool

This method tests for !=.

impl<'a> Debug for Zotero<'a>

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

Formats the value using the given formatter.