Struct humantalk::Config

pub struct Config {
    pub colors: HashMap<Severity, Color>,
    pub bug_report: Option<HowToBugReport>,
}

configuration struct for humantalk

Fields

colors: HashMap<Severity, Color>

colors hashmap for each severity level

bug_report: Option<HowToBugReport>

the bug reporting struct

Implementations

impl Config

pub fn default() -> Config

create a new configuration, with default colors and no bug report (auto-filled with default values on use)

pub fn custom( colors: HashMap<Severity, Color>, bug_report: HowToBugReport ) -> Config

create a custom config, with your own colors and bug report. If you just want custom bug report, just use this code (inverse for colors):

use humantalk::{Config, Severity, HowToBugReport};
 
let my_config = Config::custom(
    Config::default().colors,
    HowToBugReport::new(
        "message".to_string(),
        "url".to_string()
    )
);

pub fn get_color(&self, severity: &Severity) -> Color

find the specified color for a given severity

pub fn set_color(&mut self, severity: Severity, color: Color)

set the color for the specified severity level

pub fn write(&self, severity: Severity, message: &str)

write a logging message to stdout. if the binary has been compiled with –release, it will not print debug assertions.

pub fn debug(&self, message: &str)

shorthand for config.write(Severity::Debug, ...)

pub fn info(&self, message: &str)

shorthand for config.write(Severity::Info, ...)

pub fn error(&self, message: &str)

shorthand for config.write(Severity::Error, ...)

pub fn warning(&self, message: &str)

shorthand for config.write(Severity::Warning, ...)

pub fn machine_info(&self) -> String

get machine info represented as a string. Contains info including OS family, os, arch, rust version, llvm version and humantalk version

pub fn fatal_error(&self, message: &str)

error fatally, crashing the program. then exits with error code 3, indincating that erroring out has succeeded

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.