Struct Arguments 

pub struct Arguments {

    pub input_uri: Option<String>,
    pub outfile: Option<PathBuf>,
    pub largest: bool,
    pub parallelism: usize,
    pub retries: usize,
    pub retry_delay: Duration,
    pub compression: u8,
    pub headers: Vec<(String, String)>,
    pub max_idle_per_host: usize,
    pub accept_invalid_certs: bool,
    pub timeout: Duration,
    pub connect_timeout: Duration,
    pub logging: String,
    pub tile_storage_folder: Option<PathBuf>,
    /* private fields */
}

Fields

input_uri: Option<String>

Input URL or local file name

outfile: Option<PathBuf>

File to which the resulting image should be saved

largest: bool

If several zoom levels are available, then select the largest one

parallelism: usize

Degree of parallelism to use. At most this number of tiles will be downloaded at the same time.

retries: usize

Number of new attempts to make when a tile load fails before giving up. Setting this to 0 is useful to speed up the generic dezoomer, which relies on failed tile loads to detect the dimensions of the image. On the contrary, if a server is not reliable, set this value to a higher number.

retry_delay: Duration

Amount of time to wait before retrying a request that failed. Applies only to the first retry. Subsequent retries follow an exponential backoff strategy: each one is twice as long as the previous one.

compression: u8

A number between 0 and 100 expressing how much to compress the output image. For lossy output formats such as jpeg, this affects the quality of the resulting image. 0 means less compression, 100 means more compression. Currently affects only the JPEG and PNG encoders.

headers: Vec<(String, String)>

Sets an HTTP header to use on requests. This option can be repeated in order to set multiple headers. You can use -H "Referer: URL" where URL is the URL of the website’s viewer page in order to let the site think you come from the legitimate viewer.

max_idle_per_host: usize

Maximum number of idle connections per host allowed at the same time

accept_invalid_certs: bool

Whether to accept connecting to insecure HTTPS servers

timeout: Duration

Maximum time between the beginning of a request and the end of a response before the request should be interrupted and considered failed

connect_timeout: Duration

Time after which we should give up when trying to connect to a server

logging: String

Level of logging verbosity. Set it to “debug” to get all logging messages.

tile_storage_folder: Option<PathBuf>

A place to store the image tiles when after they are downloaded and decrypted. By default, tiles are not stored to disk (which is faster), but using a tile cache allows retrying partially failed downloads, or stitching the tiles with an external program.

Implementations

impl Arguments

pub fn choose_input_uri(&self) -> Result<String, ZoomError>

pub fn find_dezoomer(&self) -> Result<Box<dyn Dezoomer>, ZoomError>

pub fn best_size<I: Iterator<Item = Vec2d>>(&self, sizes: I) -> Option<Vec2d>

pub fn headers(&self) -> impl Iterator<Item = (&String, &String)>

Trait Implementations

impl Debug for Arguments

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

Formats the value using the given formatter.

impl Default for Arguments

fn default() -> Self

Returns the “default value” for a type.

impl StructOpt for Arguments

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

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

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

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + 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 Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

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