Struct html5_picture::core::Config

pub struct Config {
    pub input_dir: PathBuf,
    pub scaled_images_count: Option<u8>,
    pub install_images_into: Option<PathBuf>,
    pub force_overwrite: bool,
    pub quality_webp: Option<u8>,
}

Converts the images (currently png only) of the input folder to webp format. It also has the ability to create multiple versions of the input images having different sizes. See -s for further details. Additionally it automatically generates HTML5 tag files for you to be able to integrate them in a webpage easily.

Depends on cwebp, so make sure webp is installed on your pc!

Fields

input_dir: PathBuf

The directory containing all images that should be processed.

scaled_images_count: Option<u8>

The source image width is divided by this option (value + 1). Afterwards the source image is scaled (keeping the aspect ratio) to these widths before convertion. Useful if you want to have multiple sizes of the image on the webpage for different breakpoints.

Example:

Input image dimensions: 6000x962

Scaled images count: 3

Resulting converted images:

[filename]               [dimensions]

original_filename        6000x962

original_filename-w4500  4500x751

original_filename-w3000  3000x501

original_filename-w1500  1500x250

install_images_into: Option<PathBuf>

Installs the converted and sized pictures into the given folder.

force_overwrite: bool

If true, existing files are overwritten if install_images_into is set.

quality_webp: Option<u8>

Defines the quality of cwebp conversion.

Trait Implementations

impl Clap for Config

pub fn parse() -> Self

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

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

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

pub fn parse_from<I, T>(itr: I) -> Self where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Parse from iterator, exit on error

pub fn try_parse_from<I, T>(itr: I) -> Result<Self, Error> where
    T: Into<OsString> + Clone,
    I: IntoIterator<Item = T>, 

Parse from iterator, return Err on error.

impl Debug for Config

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

Formats the value using the given formatter.

impl FromArgMatches for Config

fn from_arg_matches(matches: &ArgMatches) -> Self

It's common to have an "application context" struct (sometimes called config) that represents all the normalized values after being processed by the CLI.

impl IntoApp for Config

fn into_app<'b>() -> App<'b>

@TODO @release @docs

fn augment_clap<'b>(app: App<'b>) -> App<'b>

@TODO @release @docs