Struct Config

#[non_exhaustive]
pub struct Config {
    pub sympols: Sympols,
    pub background: Option<ANSIColor>,
    pub flags: u8,
}

the main config structure

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sympols: Sympols

The sympols (characters) set.

background: Option<ANSIColor>

The result image background, useful if the image has a transparent parts or if you plan to use the REVERSE flag.

flags: u8

the boolean flags.

Implementations

impl Config

pub const fn new(sympols: Sympols) -> Self

Construct a new instance.

pub const fn with_flags(self, flags: u8) -> Self

Set the config flags.

pub const fn calc_buf_size(&self, w: u32, h: u32) -> usize

Calculate how much space the raw representation would use (the worst case).

impl Config

pub fn with_background(self, color: impl Into<ANSIColor>) -> Self

pub const fn new_with_background( sympols: Sympols, background_color: ANSIColor, ) -> Self

Construct a new instance with th background color set.

pub const fn reversed(&self) -> bool

return true if the REVERSE flag is set.

pub const fn use_colors(&self) -> bool

return true if the COLORS flag is set.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Hash for Config

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 for Config

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Config

fn partial_cmp(&self, other: &Config) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Config