booru-dl 0.1.0

A command line tool to download images and tags txt from booru
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

#![warn(missing_docs)]
// See: <https://doc.rust-lang.org/rustdoc/unstable-features.html#extensions-to-the-doc-attribute>
#![cfg_attr(
    docsrs,
    feature(doc_cfg, doc_auto_cfg, doc_cfg_hide),
    doc(cfg_hide(doc))
)]

//! # Usage
//!
//! <div class="warning">
//!
//! Note: API is unstable, and may change in `0.x` versions.
//!
//! </div>
//!
//! ## As a library
//!
//! As a library, usually you prefer to use [`scheduler`]
//! and [`api`] to download images from gelbooru api.
//!
//! See [`scheduler::Scheduler#example`] for example.
//!
//! ## As a binary
//!
//! In addition to the above, you also need [`cli`] to build the command line.
//!
//! See `main.rs` to know how to assemble these modules as a binary.
//!
//! # Requirements
//!
//! This crate use [`reqwest`] to send `https` requests to booru api,
//! which means [tls] is required.
//!
//! So, this crate enables [`reqwest/default-tls`] through [default features],
//! which has [**this requirement**][reqwest/default-tls:requirement].
//!
//! If you don't want to use the default tls(*I mean, system `openssl` on `linux`*),
//! you can [disable default features][default features],
//! and enable other tls features like [`rustls-tls`] or [`native-tls-vendored`].
//! See following [Feature flags](#feature-flags).
//!
//! # Feature flags
//!
//! - This crate re-exports(*same name*) all `tls` features from `reqwest`.
//!
//!     See [reqwest#optional-features] for details.
//!
//! - `cli`: Enable the command line utility.
//!
//! [tls]: https://en.wikipedia.org/wiki/Transport_Layer_Security
//! [`reqwest/default-tls`]: https://docs.rs/reqwest/0.12/reqwest/tls/index.html#default-tls
//! [default features]: https://doc.rust-lang.org/stable/cargo/reference/features.html#the-default-feature
//! [reqwest/default-tls:requirement]: https://github.com/seanmonstar/reqwest/tree/v0.12.5?tab=readme-ov-file#requirements
//! [reqwest#optional-features]: https://docs.rs/reqwest/0.12/reqwest/#optional-features
//! [`rustls-tls`]: https://github.com/rustls/rustls
//! [`native-tls-vendored`]: https://docs.rs/openssl/0.10/openssl/#vendored

#[cfg(not(any(
    feature = "default-tls",
    feature = "native-tls",
    feature = "native-tls-vendored",
    feature = "native-tls-alpn",
    feature = "rustls-tls",
    feature = "rustls-tls-manual-roots",
    feature = "rustls-tls-webpki-roots",
    feature = "rustls-tls-native-roots",
)))]
// `tls` required for `https` api
compile_error!("At least one `tls` feature must be enabled");

pub mod api;
#[cfg(feature = "cli")]
pub mod cli;
pub mod scheduler;

pub mod config;
pub mod download;
pub mod hash;
pub mod tool;