spruce - v1.0.0

spruce/message

Semantic one-line messages: success, fail, start, ready, info, warn, error.

Each function returns a formatted line (icon + label + text), indented to the context’s depth and styled when the context supports color. The print_* variants write the line to stdout.

Types

Formatter

opaque </>

Message prefix formatter.

pub opaque type Formatter

Kind

</>

The kind of semantic message, selecting its icon, color, and label.

pub type Kind {
  Success
  Fail
  Start
  Ready
  Info
  Warn
  Error
}

Constructors 

  • Success
  • Fail
  • Start
  • Ready
  • Info
  • Warn
  • Error

Options

opaque </>

Rendering options for message lines.

pub opaque type Options

Values

badge

</> 
pub fn badge() -> Formatter

Render the message prefix as an uppercase bracketed badge, e.g. [SUCCESS].

custom

</> 
pub fn custom(
  render: fn(Kind, spruce.Spruce) -> String,
) -> Formatter

Render the message prefix with a caller-supplied function.

default_options

</> 
pub fn default_options() -> Options

Create default message rendering options.

error

</> 
pub fn error(sp: spruce.Spruce, text: String) -> String

Format an error message line.

error_with

</> 
pub fn error_with(
  sp: spruce.Spruce,
  text: String,
  options: Options,
) -> String

Format an error message line with explicit rendering options.

fail

</> 
pub fn fail(sp: spruce.Spruce, text: String) -> String

Format a fail message line.

fail_with

</> 
pub fn fail_with(
  sp: spruce.Spruce,
  text: String,
  options: Options,
) -> String

Format a fail message line with explicit rendering options.

info

</> 
pub fn info(sp: spruce.Spruce, text: String) -> String

Format an info message line.

info_with

</> 
pub fn info_with(
  sp: spruce.Spruce,
  text: String,
  options: Options,
) -> String

Format an info message line with explicit rendering options.

label

</> 
pub fn label() -> Formatter

Render the message prefix as icon plus lowercase label, e.g. ✔ success.

line_with

</> 
pub fn line_with(
  sp: spruce.Spruce,
  kind: Kind,
  text: String,
  options: Options,
) -> String

Format a message line with explicit rendering options.

</> 
pub fn print_error(sp: spruce.Spruce, text: String) -> Nil

Print an error message to stdout.

</> 
pub fn print_fail(sp: spruce.Spruce, text: String) -> Nil

Print a fail message to stdout.

</> 
pub fn print_info(sp: spruce.Spruce, text: String) -> Nil

Print an info message to stdout.

</> 
pub fn print_ready(sp: spruce.Spruce, text: String) -> Nil

Print a ready message to stdout.

</> 
pub fn print_start(sp: spruce.Spruce, text: String) -> Nil

Print a start message to stdout.

</> 
pub fn print_success(sp: spruce.Spruce, text: String) -> Nil

Print a success message to stdout.

</> 
pub fn print_warn(sp: spruce.Spruce, text: String) -> Nil

Print a warn message to stdout.

ready

</> 
pub fn ready(sp: spruce.Spruce, text: String) -> String

Format a ready message line.

ready_with

</> 
pub fn ready_with(
  sp: spruce.Spruce,
  text: String,
  options: Options,
) -> String

Format a ready message line with explicit rendering options.

simple

</> 
pub fn simple() -> Formatter

Render the message prefix as an uppercase bare label, e.g. SUCCESS.

start

</> 
pub fn start(sp: spruce.Spruce, text: String) -> String

Format a start message line.

start_with

</> 
pub fn start_with(
  sp: spruce.Spruce,
  text: String,
  options: Options,
) -> String

Format a start message line with explicit rendering options.

success

</> 
pub fn success(sp: spruce.Spruce, text: String) -> String

Format a success message line.

success_with

</> 
pub fn success_with(
  sp: spruce.Spruce,
  text: String,
  options: Options,
) -> String

Format a success message line with explicit rendering options.

warn

</> 
pub fn warn(sp: spruce.Spruce, text: String) -> String

Format a warn message line.

warn_with

</> 
pub fn warn_with(
  sp: spruce.Spruce,
  text: String,
  options: Options,
) -> String

Format a warn message line with explicit rendering options.

with_details

</> 
pub fn with_details(
  options: Options,
  details: details.Details,
) -> Options

Include key-value details after the message text.

with_formatter

</> 
pub fn with_formatter(
  options: Options,
  formatter: Formatter,
) -> Options

Select a message prefix formatter.

with_symbol_mode

</> 
pub fn with_symbol_mode(
  options: Options,
  mode: symbol.Mode,
) -> Options

Select whether message status glyphs render as Unicode or ASCII.

✨ Search Document