Struct xmt::XMT

source · [−]

pub struct XMT { /* private fields */ }

Expand description

Root formatter struct.

Implementations

source

pub fn print(&self, msg: &str)

Print a message.

If stdout is a TTY, the message will be printed with the style defined by the config for Level::Normal. If stdout is not a TTY, the message is printed with no formatting.

If the output mode is JSON, the message is not printed.

pub fn detail(&self, msg: &str)

Print a message.

If stdout is a TTY, the message will be printed with the style defined by the config for Level::Detail. If stdout is not a TTY or if the output mode is JSON, the message is not printed.

pub fn success(&self, msg: &str)

Print a success message.

If stdout is a TTY, the message will be printed with the style defined by the config for Level::Success. If stdout is not a TTY, the message is printed with no formatting.

pub fn out<S: Serialize + Display>(&self, obj: S)

Output a structure.

If output mode is JSON or if stdout is not a TTY, the structure is serialized to JSON and printed to stdout. If output mode is Tree, the structure is serialized to a tree and printed to stdout. If output mode is Text, the structure is printed to stdout using fmt::Display.

Example

use serde::Serialize;
use xmt::XMT;

#[derive(Serialize)]
struct Thing {
    name: String,
}

impl std::fmt::Display for Thing {
   fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
       write!(f, "{}", self.name)
   }
}

let xmt = XMT::default();
xmt.out(Thing{name: "thing".to_string()});

source

pub fn warn(&self, msg: &str)

Print a warning.

If stdout is a TTY, the message will be printed with the style defined by the config for Level::Warn. If stdout is not a TTY, the message is printed with no formatting.

If the output mode is set to JSON, the warning is not printed.

Example

use xmt::XMT;

let xmt = XMT::default();
xmt.warn("something strange happened");

source

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

Print an error.

If error is a TTY, the message will be printed with the style defined by the config for Level::Error. If error is not a TTY, the message is printed with no formatting.

If the output mode is set to JSON, the error is not printed.

Example

use xmt::XMT;

let xmt = XMT::default();
xmt.error("something bad happened");

source

pub fn nest(&self) -> Self

Execute the provided closure in a nested scope within the global XMT instance.

Example

use xmt::XMT;

let xmt = XMT::default();

xmt.print("Hello");
xmt.nest().print("Within scope");

// Prints:
// Hello
//   Within scope

source

pub fn prompt_yn(&self, msg: &str, default: bool) -> Result<bool>

Prompt the user for a yes/no answer.

Errors

Returns an io::Error error if stdout is not a TTY or if reading from stdin failed.

Example

use xmt::XMT;

let xmt = XMT::default();
if xmt.prompt_yn("Are you sure?", false)? {
    // do the thing
}

Returns

true if the user answered yes, false if the user answered no.

source

pub fn prompt(&self, msg: &str) -> Result<String>

Prompt the user for input.

Errors

Returns an io::Error error if stdout is not a TTY or if reading from stdin failed.

Example

use xmt::XMT;

let xmt = XMT::default();
let name = xmt.prompt("What is your name?")?;
println!("Hello, {}!", name);

Returns

The text entered by the user.

source

pub fn pick<'a, E: Display>(&self, msg: &str, items: &'a [E]) -> Result<&'a E>

Prompt the user to select an item from a list.

Errors

Returns an io::Error error if stdout is not a TTY or if reading from stdin failed.

Example

use xmt::XMT;

let xmt = XMT::default();

let choices = vec!["foo", "bar", "baz"];
let pick = xmt.pick("Pick one", &choices)?;
println!("You picked: {}", pick);