Struct dither::prelude::Opt

pub struct Opt {
    pub verbose: bool,
    pub input: PathBuf,
    pub bit_depth: u8,
    pub output: Option<PathBuf>,
    pub ditherer: Ditherer<'static>,
    pub color_mode: Mode,
}

Command-line interface & arguments. See structopt.

Fields

verbose: bool

Provide verbose debug information. Default is false.

input: PathBuf

Input file. Supported file types: PNG JPEG GIF BMP ICO TIFF

bit_depth: u8

the folder to scan for image files Color depth. Must be between 1 and 8. See create_quantize_n_bits_func and [create_convert_quantized_to_palette_func][crate::create_convert_quantized_to_palette_func]

output: Option<PathBuf>

Output file: will be written to as a .png or .jpg (inferred from file extension). If left empty, a default output path will be created: see Opt::output_path

ditherer: Ditherer<'static>

Ditherering algorithm to use. Options are

• "floyd" (default)
• "atkinson"
• "stucki",
• "burkes"
• "jarvis"
• "sierra3"

color_mode: Mode

Color mode to use. Options are

• bw => grayscale with the specified bit depth. (default)
• color => color mode with the specified bit depth.
• cga => load the cga palette. equivalent to "cga.plt".
• crayon => load the crayon palette. equivalent to "crayon.plt"
• $COLOR => single-color mode. options are
• $FILENAME" => load palette from file, listed as line-separated RGB values. see "cga.plt" and the readme for more information on palette files.

Methods

impl Opt

pub fn input_path<'a>(&'a self) -> Result<PathBuf>

the canonicalized input path

pub fn output_path<'a>(&'a self) -> Result<Cow<'a, Path>>

the actual output path. if opts.output exists, this is that, otherwise, this is "{base}_dithered_{dither}_{color}_{depth}.png", where base is the canonicalized input path, stripped of it's extension. $dither bunny.png --color=color --dither=atkinson --depth=2 will save to bunny_atkinson_c_2.png

let mut opt = Opt::default();
opt.bit_depth=1;
opt.input = PathBuf::from("bunny.png".to_string());
let got_path = opt.output_path().unwrap();
assert_eq!("bunny_dithered_floyd_bw_1.png", Path::file_name(got_path.as_ref().as_ref()).unwrap().to_string_lossy());

Trait Implementations

impl Clone for Opt

fn clone(&self) -> Opt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Opt> for Opt

fn eq(&self, other: &Opt) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Opt) -> bool

This method tests for !=.

impl Default for Opt

fn default() -> Opt

Returns the "default value" for a type.

impl Debug for Opt

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

Formats the value using the given formatter.

impl StructOpt for Opt

fn clap<'a, 'b>() -> App<'a, 'b>

Returns the corresponding clap::App.

fn from_clap(matches: &ArgMatches) -> Self

Creates the struct from clap::ArgMatches. It cannot fail with a parameter generated by clap by construction.

fn from_args() -> Self

Gets the struct from the command line arguments. Print the error message and quit the program in case of failure.

fn from_iter<I>(iter: I) -> Self where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error> where
    I: IntoIterator,
    <I as IntoIterator>::Item: Into<OsString>,
    <I as IntoIterator>::Item: Clone, 

Gets the struct from any iterator such as a Vec of your making.