Struct Cli

pub struct Cli {
    pub mode: Commands,
    pub imageboard: ServerConfig,
    pub servers: bool,
    pub output: Option<PathBuf>,
    pub simultaneous_downloads: u8,
    pub auth: bool,
    pub save_file_as_id: bool,
    pub cbz: bool,
    pub annotate: bool,
    pub overwrite: bool,
}

Fields

mode: Commands

imageboard: ServerConfig

Specify which website to download from

Default websites include: [“danbooru”, “e621”, “gelbooru”, “rule34”, “realbooru”, “konachan”]

servers: bool

Print all available servers and exit

output: Option<PathBuf>

Where to save files (If the path doesn’t exist, it will be created.)

simultaneous_downloads: u8

Number of simultaneous downloads

[max: 20]

auth: bool

Authenticate to the imageboard website.

This flag only needs to be set a single time.

Once authenticated, it’s possible to use your blacklist to exclude posts with unwanted tags

save_file_as_id: bool

Save files with their ID as filename instead of it’s MD5

If the output dir has the same file downloaded with the MD5 name, it will be renamed to the post’s ID

cbz: bool

Save posts inside a cbz file.

Will ask to overwrite the destination file.

annotate: bool

Write tags in a txt file next to the downloaded image (for Stable Diffusion training)

overwrite: bool

Always overwrite output

Implementations

impl Cli

pub const fn name_type(&self) -> NameType

pub fn get_extension(&self) -> Option<Extension>

pub fn generate_save_path(&self) -> Result<PathBuf, Error>

Trait Implementations

impl Args for Cli

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl CommandFactory for Cli

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Cli

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

Formats the value using the given formatter.

impl FromArgMatches for Cli

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Cli

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.