Struct hydrus_api::api_core::client::Client

pub struct Client { /* private fields */ }

A low level Client for the hydrus API. It provides basic abstraction over the REST api.

Implementations

impl Client

pub fn builder() -> ClientBuilder

Returns a builder for the client

pub fn new<S: AsRef<str>>(url: S, access_key: S) -> Self

Creates a new client to start requests against the hydrus api.

pub async fn api_version(&self) -> Result<ApiVersionResponse>

Returns the current API version. It’s being incremented every time the API changes.

pub async fn session_key(&self) -> Result<SessionKeyResponse>

Creates a new session key

pub async fn verify_access_key(&self) -> Result<VerifyAccessKeyResponse>

Verifies if the access key is valid and returns some information about its permissions

pub async fn get_services(&self) -> Result<GetServicesResponse>

Returns the list of tag and file services of the client

pub async fn add_file<S: ToString + Debug>(
    &self,
    path: S
) -> Result<AddFileResponse>

Adds a file to hydrus

pub async fn add_binary_file(&self, data: Vec<u8>) -> Result<AddFileResponse>

Adds a file from binary data to hydrus

pub async fn delete_files(&self, hashes: Vec<String>) -> Result<()>

Moves files with matching hashes to the trash

pub async fn undelete_files(&self, hashes: Vec<String>) -> Result<()>

Pulls files out of the trash by hash

pub async fn archive_files(&self, hashes: Vec<String>) -> Result<()>

Moves files from the inbox into the archive

pub async fn unarchive_files(&self, hashes: Vec<String>) -> Result<()>

Moves files from the archive into the inbox

pub async fn clean_tags(&self, tags: Vec<String>) -> Result<CleanTagsResponse>

Returns the list of tags as the client would see them in a human friendly order

pub async fn add_tags(&self, request: AddTagsRequest) -> Result<()>

Adds tags to files with the given hashes

pub async fn search_files(
    &self,
    query: Vec<SearchQueryEntry>,
    options: FileSearchOptions
) -> Result<SearchFilesResponse>

Searches for files

pub async fn search_file_hashes(
    &self,
    query: Vec<SearchQueryEntry>,
    options: FileSearchOptions
) -> Result<SearchFileHashesResponse>

Searches for file hashes

pub async fn get_file_metadata(
    &self,
    file_ids: Vec<u64>,
    hashes: Vec<String>
) -> Result<FileMetadataResponse>

Returns the metadata for a given list of file_ids or hashes

pub async fn get_file_metadata_by_identifier(
    &self,
    id: FileIdentifier
) -> Result<FileMetadataInfo>

Returns the metadata for a single file identifier

pub async fn get_file(&self, id: FileIdentifier) -> Result<FileRecord>

Returns the bytes of a file from hydrus

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

Returns all files associated with the given url

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

Returns information about the given url

pub async fn add_url(&self, request: AddUrlRequest) -> Result<AddUrlResponse>

Adds an url to hydrus, optionally with additional tags and a destination page

pub async fn associate_urls(
    &self,
    urls: Vec<String>,
    hashes: Vec<String>
) -> Result<()>

Associates urls with the given file hashes

pub async fn disassociate_urls(
    &self,
    urls: Vec<String>,
    hashes: Vec<String>
) -> Result<()>

Disassociates urls with the given file hashes

pub async fn set_notes(
    &self,
    id: FileIdentifier,
    notes: HashMap<String, String>
) -> Result<()>

Sets the notes for the file

pub async fn delete_notes(
    &self,
    id: FileIdentifier,
    note_names: Vec<String>
) -> Result<()>

Deletes the notes of a file

pub async fn get_pages(&self) -> Result<GetPagesResponse>

Returns all pages of the client

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

Returns information about a single page

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

Focuses a page in the client

pub async fn add_files_to_page<S: ToString + Debug>(
    &self,
    page_key: S,
    file_ids: Vec<u64>,
    hashes: Vec<String>
) -> Result<()>

Adds files to a page

pub async fn get_cookies<S: AsRef<str> + Debug>(
    &self,
    domain: S
) -> Result<GetCookiesResponse>

Returns all cookies for the given domain

pub async fn set_cookies(
    &self,
    cookies: Vec<[OptionalStringNumber; 5]>
) -> Result<()>

Sets some cookies for some websites. Each entry needs to be in the format [<name>, <value>, <domain>, <path>, <expires>] with the types [String, String, String, String, u64]

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

Sets the user agent that is being used for every request hydrus starts

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.