Struct dither::opts::Opt

pub struct Opt {
    pub verbose: bool,
    pub input: PathBuf,
    pub bit_depth: u8,
    pub ditherer: Ditherer,
    pub color_mode: Mode,
    // some fields omitted
}

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

Color depth. Must be between 1 and 8.

ditherer: Ditherer

Ditherering algorithm to use. Options are "floyd", "atkinson", "stucki", "burkes","jarvis", "sierra3"

color_mode: Mode

Color mode to use. Options are "color", "bw", "cga", $SINGLE_COLOR, "$FRONT_PALETTE $BACKPALETTE"; (all colors with specified bit depth) "bw" -> black and white mode (grayscale in higher birt depths) $COLOR => single-color mode. options are ["BLUE", "GREEN", "CYAN", "RED", "MAGENTA", "BROWN", "LIGHT_GRAY", "GRAY", "LIGHT_BLUE", "LIGHT_GREEN", "LIGHT_CYAN", "LIGHT_RED" "LIGHT_MAGENTA", "YELLOW", "WHITE" ("0xZZZZZZ 0xZZZZZZZ") -> user specified 1bit user color palette; where the first is foreground in hexidecimal and the second is background. "cga" -> sixteen-color CGA. ignores bit depth; casues error on bit depth > 1

Methods

impl Opt

pub fn output_path(&self) -> Cow<PathBuf>

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

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