Struct termimage::Options

pub struct Options {
    pub image: (String, PathBuf),
    pub size: (u32, u32),
    pub preserve_aspect: bool,
    pub ansi_out: Option<AnsiOutputFormat>,
}

Representation of the application’s all configurable values.

Fields

image: (String, PathBuf)

Image file to display.

This tuple contains the plaintext name (user-friendly) and a normalised path (programmer-friendly).

size: (u32, u32)

Output size. Default: detected from terminal size or no default.

preserve_aspect: bool

Whether to preserve the image’s aspect ratio when resizing. Default: true.

ansi_out: Option<AnsiOutputFormat>

Whether to output ANSI escapes and in which format. Default: None on Windooze when not writing to a file.

Implementations

impl Options

pub fn parse() -> Options

Parse env-wide command-line arguments into an Options instance

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Hash for Options

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Options> for Options

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Options

impl StructuralEq for Options

impl StructuralPartialEq for Options