Struct pikchr::PikchrFlags[][src]

pub struct PikchrFlags { /* fields omitted */ }

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[src]

pub fn plain_errors(&self) -> bool[src]

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[src]

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[src]

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[src]

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[src]

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[src]

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[src]

fn clone(&self) -> PikchrFlags[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl Default for PikchrFlags[src]

fn default() -> Self[src]

Returns the “default value” for a type. Read more

impl Copy for PikchrFlags[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.