Skip to main content

Module shell

foundry_common::io

Module shell

Expand description

Utility functions for writing to stdout and stderr.

Originally from cargo.

Re-exports§

use anstream::AutoStream; 🔒
use anstyle::Style; 🔒
use clap::ValueEnum; 🔒
use eyre::Result; 🔒
use serde::Deserialize; 🔒
use serde::Deserialize; 🔒
use serde::Serialize; 🔒
use serde::Serialize; 🔒
use std::fmt; 🔒
use std::io::IsTerminal; 🔒
use std::ops::DerefMut; 🔒
use std::sync::Mutex; 🔒
use std::sync::OnceLock; 🔒
use std::sync::PoisonError; 🔒
use std::sync::atomic::AtomicBool; 🔒
use std::sync::atomic::Ordering; 🔒
use super::style::*; 🔒
use std::io::prelude::*; 🔒

Structs§

Shell: An abstraction around console output that remembers preferences for output verbosity and color.

Enums§

ColorChoice: Whether messages should use color output.
OutputFormat: The requested output format.
OutputMode: The requested output mode.
ShellOut 🔒: A Writeable object, either with or without color support.

Statics§

GLOBAL_SHELL 🔒: The global shell instance.

Functions§

color_choice: Returns the current color choice.
is_err_tty: Returns whether stderr is a terminal (tty).
is_json: Returns whether the output format is OutputFormat::Json.
is_markdown: Returns whether the output format is OutputFormat::Markdown.
is_out_tty: Returns whether stdout is a terminal (tty).
is_quiet: Returns whether the output mode is OutputMode::Quiet.
set_verbosity: Set the verbosity level.
supports_color 🔒
verbosity: Returns the currently set verbosity level.

Type Aliases§

Verbosity: The verbosity level.