Crate fyi_msg

FYI Msg

This crate contains the objects providing the heart of the FYI command line application, namely Msg, a simple struct for status-like messages that can be easily printed to STDOUT or STDERR.

Examples

use fyi_msg::{Msg, MsgKind};

// One way.
Msg::new(MsgKind::Success, "You did it!")
    .with_newline(true)
    .print();

// Another equivalent way.
Msg::success("You did it!").print();

For more usage examples, check out the examples/msg demo, which covers just about every common use case.

Macros

Macro	Equivalent
confirm!(…)	Msg::new(MsgKind::Confirm, "Some question…").prompt()

Optional Features

Feature	Description
fitted	Enables Msg::fitted for obtaining a slice trimmed to a specific display width.
progress	Enables Progless, a thread-safe CLI progress bar displayer.
timestamps	Enables timestamp-related methods and flags like Msg::with_timestamp.

Re-exports

pub use fyi_ansi;

pub use signal_hook;signal-hook

Macros

confirm

Confirm.

Structs

BeforeAfterprogress

Before and After.

Msg

Message.

Proglessprogress

Progless.

ProglessTaskGuardprogress

Progless Task Guard.

Enums

AnsiColor

ANSI Colors (8/16/256).

MsgKind

Message Kind.

ProglessErrorprogress

Obligatory error type.

Functions

fit_to_widthfitted

Fit to Width.

length_widthfitted

Length Width.

widthfitted

Width.