Struct hydrus_api::wrapper::hydrus_file::HydrusFile

pub struct HydrusFile {
    pub id: FileIdentifier,
    pub status: FileStatus,
    /* private fields */
}

Fields

id: FileIdentifier

status: FileStatus

Implementations

impl HydrusFile

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

Deletes the internally stored metadata about the file retrieves it again

pub async fn hash(&mut self) -> Result<String>

Returns the hash of the file if the file identifier is an id it calls hydrus to resolve the file

pub async fn size(&mut self) -> Result<Option<u64>>

Returns the file size in bytes

pub async fn mime(&mut self) -> Result<Mime>

Returns the mime of the file

pub async fn ext(&mut self) -> Result<String>

Return the file extension

pub async fn dimensions(&mut self) -> Result<Option<(u32, u32)>>

Returns the dimensions of the file in pixels

pub async fn duration(&mut self) -> Result<Option<u64>>

Returns the duration of the file in seconds if it’s a video

pub async fn num_frames(&mut self) -> Result<Option<u64>>

Returns the number of frames of the file if it’s a video

pub async fn has_audio(&mut self) -> Result<bool>

Returns if the file has audio

pub async fn in_inbox(&mut self) -> Result<bool>

Returns if the file is currently in the inbox

pub async fn stored_locally(&mut self) -> Result<bool>

Returns if the file is stored locally

pub async fn moved_to_trashed(&mut self) -> Result<bool>

Returns if the file has been moved to the trash

pub async fn urls(&mut self) -> Result<&Vec<String>>

Returns all urls associated with the file

pub async fn time_modified(&mut self) -> Result<Option<NaiveDateTime>>

Returns the modified time of the file

pub async fn time_imported<S: AsRef<str>>(
    &mut self,
    service_key: S
) -> Result<Option<NaiveDateTime>>

Returns the imported time of the file for a given file service key

pub async fn time_deleted<S: AsRef<str>>(
    &mut self,
    service_key: S
) -> Result<Option<NaiveDateTime>>

Returns the time the file was deleted for a specified file service

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

Associates the file with a list of urls

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

Disassociates the file with a list of urls

pub async fn service_names_with_tags(
    &mut self
) -> Result<HashMap<ServiceName, Vec<Tag>>>

👎 Deprecated:

Deprecated in the official API. Use services_with_tags instead.

Returns map mapping lists of tags to services.

Deprecation: Use HydrusFile::services_with_tags instead.

pub async fn services_with_tags(
    &mut self
) -> Result<HashMap<ServiceIdentifier, Vec<Tag>>>

Returns a mapping with service ids mapped to tags

pub async fn tags(&mut self) -> Result<Vec<Tag>>

Returns a list of all tags assigned to the file

pub async fn add_tags(
    &mut self,
    service: ServiceIdentifier,
    tags: Vec<Tag>
) -> Result<()>

Adds tags for a specific service to the file

pub async fn modify_tags(
    &mut self,
    service: ServiceIdentifier,
    action: TagAction,
    tags: Vec<Tag>
) -> Result<()>

Allows modification of tags by using the defined tag actions

pub fn add_notes(&self) -> AddNotesBuilder

Creates a builder to add notes to the file

pub async fn delete_note<S1: ToString>(&self, name: S1) -> Result<()>

Deletes a single note from the file

pub async fn delete_notes<I: IntoIterator<Item = S>, S: ToString>(
    &self,
    names: I
) -> Result<()>

Deletes multiple notes from the file

pub async fn retrieve(&self) -> Result<FileRecord>

Retrieves the file record bytes

Trait Implementations

impl Clone for HydrusFile

fn clone(&self) -> HydrusFile

Returns a copy of the value.

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

Performs copy-assignment from source.