Struct pikchr::PikchrFlags

pub struct PikchrFlags { /* private fields */ }

Flags for converting pikchr source

You can construct a default set of flags using the std::default::Default trait

The default flags will generate plain text errors and light-mode diagrams

Implementations

impl PikchrFlags

pub fn plain_errors(&self) -> bool

Return whether or not plain text errors will be generated

let flags = PikchrFlags::default();
assert!(flags.plain_errors())

pub fn generate_plain_errors(&mut self) -> &mut PikchrFlags

Request plain text errors be generated

let mut flags = PikchrFlags::default();
flags.generate_plain_errors();
assert!(flags.plain_errors());

pub fn generate_html_errors(&mut self) -> &mut PikchrFlags

Request help encoded errors be generated

let mut flags = PikchrFlags::default();
flags.generate_html_errors();
assert!(!flags.plain_errors());

pub fn dark_mode(&self) -> bool

Return whether or not dark mode will be used for images

let flags = PikchrFlags::default();
assert!(!flags.dark_mode());

pub fn use_dark_mode(&mut self) -> &mut PikchrFlags

Set the dark-mode flag

let mut flags = PikchrFlags::default();
flags.use_dark_mode();
assert!(flags.dark_mode());

pub fn clear_dark_mode(&mut self) -> &mut PikchrFlags

Clear the dark-mode flag

let mut flags = PikchrFlags::default();
flags.use_dark_mode();
flags.clear_dark_mode();
assert!(!flags.dark_mode());

Trait Implementations

impl Clone for PikchrFlags

fn clone(&self) -> PikchrFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PikchrFlags

fn default() -> Self

Returns the “default value” for a type.

impl From<PikchrFlags> for c_uint

fn from(val: PikchrFlags) -> c_uint

Converts to this type from the input type.

impl Copy for PikchrFlags