Struct hydrus_api::wrapper::hydrus::Hydrus

pub struct Hydrus { /* private fields */ }

A high level wrapper for the hydrus API for easier management of files, tags urls etc.

Implementations

impl Hydrus

pub fn new(client: Client) -> Self

Creates a new high level Hydrus API client

pub async fn version(&self) -> Result<Version>

Returns the Hydrus and API Version

pub async fn services(&self) -> Result<Services>

Returns a list of available services

pub fn import(&self) -> ImportBuilder

Creates an import builder to build an import request to hydrus

pub fn address<S: AsRef<str> + Debug>(&self, address: S) -> Address

Returns the address as an object that can be used to get and set cookies

pub async fn url<S: AsRef<str> + Debug>(&self, url: S) -> Result<Url>

Returns information about a given url in an object that allows further operations with that url

pub async fn file(&self, identifier: FileIdentifier) -> Result<HydrusFile>

Returns a file by identifier to perform further operations on

pub async fn delete(&self) -> DeleteFilesBuilder

Creates a builder to delete files

pub fn tagging(&self) -> TaggingBuilder

Starts a request to bulk add tags to files

pub fn search(&self) -> SearchBuilder

Starts a request to search for files

pub fn search_tags<S: ToString>(&self, query: S) -> TagSearchBuilder

Starts a search request for tags with additional filter options

pub async fn page<S: AsRef<str> + Debug>( &self, page_key: S ) -> Result<HydrusPage>

Returns a hydrus page by page key

pub async fn root_page(&self) -> Result<HydrusPage>

Returns the root page in the client

pub async fn set_user_agent<S: ToString + Debug>( &self, user_agent: S ) -> Result<()>

Sets the user agent hydrus uses for http requests

pub async fn get_service_key( &self, service: ServiceIdentifier ) -> Result<String>

Returns the key for a given service identifier