Module colorz::mode

Flags to control if any styling should occur

There are three levels, in order of precedence

• feature flags - compile time (strip-colors)
• global - runtime set_coloring_mode, set_coloring_mode_from_env
• per value - runtime StyledValue::stream

higher precedence options forces coloring or no-coloring even if lower precedence options specify otherwise.

For example, using StyledValue::stream to Stream::AlwaysColor doesn’t gurantee that any coloring will happen. For example, if the strip-colors feature flag is set or if set(Mode::Never) was called before.

However, these flags only control coloring on StyledValue, so using the color types directly to color values will always be supported (even with strip-colors).

Structs

• ModeFromStrError
  An error if deserializing a mode from a string fails
• StreamFromStrError
  An error if deserializing a mode from a string fails

Enums

• ColorKind
  The coloring kinds
• Mode
  The coloring mode
• Stream
  The stream to detect when to color on

Functions

• get_coloring_mode
  Get the global coloring mode
• get_default_stream
  Get the default stream
• set_coloring_mode
  Set the global coloring mode (this allows forcing colors on or off despite stream preferences)
• set_coloring_mode_from_envstd
  Reads the current mode from the environment
• set_default_stream
  Set the default stream if one isn’t chosen per value