21 releases

0.10.2 Dec 21, 2023
0.9.3 May 14, 2022
0.8.0 Mar 29, 2022
0.6.0 Sep 5, 2021
0.4.0 Jul 31, 2021

#11 in #client-api

Download history 15/week @ 2023-11-06 31/week @ 2023-11-13 33/week @ 2023-11-20 69/week @ 2023-11-27 7/week @ 2023-12-04 29/week @ 2023-12-11 126/week @ 2023-12-18 56/week @ 2023-12-25 35/week @ 2024-01-01 17/week @ 2024-01-08 13/week @ 2024-01-15 25/week @ 2024-01-22 51/week @ 2024-01-29 32/week @ 2024-02-05 106/week @ 2024-02-12 446/week @ 2024-02-19

635 downloads per month
Used in 2 crates

Apache-2.0

140KB
3.5K SLoC

Hydrus Rust API

This is a WIP Rust Wrapper for the Hydrus Client API. The official API documentation can be found here.

Example with Wrapper

use std::env;
use hydrus_api::api_core::searching_and_fetching_files::FileSearchLocation;
use hydrus_api::wrapper::tag::Tag;
use hydrus_api::wrapper::service::ServiceName;
use hydrus_api::wrapper::hydrus_file::FileStatus;
use hydrus_api::wrapper::page::PageIdentifier;
use hydrus_api::wrapper::builders::search_builder::SortType;
use hydrus_api::wrapper::builders::or_chain_builder::OrChainBuilder;
use hydrus_api::wrapper::builders::tag_builder::{
    SystemTagBuilder, Comparator
};

#[tokio::main]
async fn main() {
    let hydrus_url = env::var("HYDRUS_URL").unwrap();
    let access_key = env::var("HYDRUS_ACCESS_KEY").unwrap();
    
    let hydrus = Hydrus::new(Client::new(hydrus_url, access_key));
    let files = hydrus.search()
        .add_tag(Tag::from("character:megumin"))
        .add_tag(SystemTagBuilder::new().archive().build())
        .add_tag(SystemTagBuilder::new().number_of_tags(Comparator::Greater, 12).build())
        .add_or_chain(
            OrChainBuilder::new()
                .add_tag("summer".into())
                .add_tag("winter".into())
                .build(),
        )
        .sort(SortType::ModifiedTime)
        .run().await.unwrap();

    for mut file in files {
        file.add_tags(ServiceName::my_tags().into(), vec![Tag::from("ark mage")]).await.unwrap();
    }

    let url = hydrus.import()
        .url("https://www.pixiv.net/member_illust.php?illust_id=83406361&mode=medium")
        .page(PageIdentifier::name("My Import Page"))
        .add_additional_tag(ServiceName::my_tags().into(), Tag::from("character:megumin"))
        .show_page(true)
        .run().await.unwrap();
}

Example with Client

use hydrus_api::Client;
use hydrus_api::paths::adding_tags::{AddTagsRequestBuilder, TagAction};
use std::env;
use hydrus_api::api_core::common::ServiceIdentifier;

#[tokio::main]
async fn main() {
    Client::new(
        env::var("HYDRUS_URL").unwrap(),
        env::var("HYDRUS_ACCESS_KEY").unwrap(),
    );
    // let's first import a file
    let hash = client.add_file("/path/to/my/file").await.unwrap().hash;
    
    // and now let's add tags to it
    let request = AddTagsRequestBuilder::default()
        .add_hash(hash)
        // for each tag the service has to be specified
        .add_tags(ServiceIdentifier::name("my tags"), vec!["beach".into(), "summer".into()])
        // with tag actions tags can also be removed. It's especially useful for the PTR
        .add_tag_with_action(ServiceIdentifier::name("my tags"), "rain", TagAction::DeleteFromLocalService)
        .build();
    
    client.add_tags(request).await.unwrap();
}

License

Apache-2.0

Dependencies

~7–23MB
~361K SLoC