Struct ibdl_core::cli::Cli

pub struct Cli {

    pub tags: Vec<String>,
    pub imageboard: ImageBoardArg,
    pub output: Option<PathBuf>,
    pub precise_output: Option<PathBuf>,
    pub simultaneous_downloads: u8,
    pub auth: bool,
    pub safe_mode: bool,
    pub save_file_as_id: bool,
    pub no_animated: bool,
    pub limit: Option<u16>,
    pub async_download: bool,
    pub disable_blacklist: bool,
    pub cbz: bool,
    pub start_page: Option<u16>,
    pub update: bool,
    pub rating: Vec<RatingArg>,
    pub ignore_unknown: bool,
    pub annotate: bool,
    pub exclude: Vec<String>,
    pub force_extension: Option<String>,
}

Fields

tags: Vec<String>

Tags to search

imageboard: ImageBoardArg

Specify which website to download from

output: Option<PathBuf>

Where to save downloaded files

precise_output: Option<PathBuf>

Use this option to save files directly to the specified directory without creating additional dirs

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

safe_mode: bool

Download images from the safe version of the selected Imageboard.

Useful if you only want to download posts with “safe” rating.

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

no_animated: bool

Do not download animated gifs or video files

limit: Option<u16>

Set a max number of posts to download.

[max: 65535]

async_download: bool

Enable experimental async downloader (currently only available for Danbooru)

disable_blacklist: bool

Disable blacklist filtering

cbz: bool

Save posts inside a cbz file.

Will always overwrite the destination file.

start_page: Option<u16>

Select from which page to start scanning posts

[max: 65535]

update: bool

Download only the latest images for tag selection.

Will not re-download already present or deleted images from destination directory

rating: Vec<RatingArg>

Download posts with the selected rating. Can be used multiple times to download posts with other ratings

ignore_unknown: bool

Do not download posts with an unknown rating

annotate: bool

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

exclude: Vec<String>

Exclude posts with these tags

force_extension: Option<String>

Implementations

impl Cli

pub fn name_type(&self) -> NameType

pub fn selected_ratings(&self) -> Vec<Rating>

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][crate::ArgGroup::id] for this set of arguments

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

Append to [Command] so it can instantiate Self.

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

Append to [Command] so it can update self.

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<RichFormatter>>

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

fn parse_from<I, T>(itr: I) -> Selfwhere 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<RichFormatter>>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<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.