Struct hydrus_api::client::Client

pub struct Client { /* fields omitted */ }

Implementations

impl Client

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

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

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

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

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

Creates a new session key

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

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

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

Returns the list of tag and file services of the client

pub async fn add_file<S: AsRef<str>>(
    &mut self,
    path: S
) -> Result<AddFileResponse>

Adds a file to hydrus

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

Adds a file from binary data to hydrus

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

Moves files with matching hashes to the trash

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

Pulls files out of the trash by hash

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

Moves files from the inbox into the archive

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

Moves files from the archive into the inbox

pub async fn clean_tags(
    &mut 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(&mut self, request: AddTagsRequest) -> Result<()>

Adds tags to files with the given hashes

pub async fn search_files(
    &mut self,
    tags: Vec<String>,
    location: FileSearchLocation
) -> Result<SearchFilesResponse>

Searches for files in the inbox, the archive or both

pub async fn get_file_metadata(
    &mut 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(&mut self, id: FileIdentifier) -> Result<FileRecord>

Returns the bytes of a file from hydrus

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

Returns all files associated with the given url

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

Returns information about the given url

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

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

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

Associates urls with the given file hashes

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

Disassociates urls with the given file hashes