Struct ockam_command::Terminal

pub fn new( quiet: bool, no_color: bool, no_input: bool, output_format: OutputFormat ) -> Self

pub fn is_tty(&self) -> bool

pub fn quiet() -> Self

pub fn confirm(&self, msg: impl AsRef<str>) -> Result<ConfirmResult>

Prompt the user for a confirmation.

pub fn confirmed_with_flag_or_prompt( &self, flag: bool, prompt_msg: impl AsRef<str> ) -> Result<bool>

pub fn confirm_interactively(&self, header: String) -> bool

pub fn select_multiple(&self, header: String, items: Vec<String>) -> Vec<String>

Returns the selected items by the user, or an empty Vec if the user did not select any item or if the user is not able to select an item (e.g. not a TTY, --no-input flag, etc.).

pub fn can_ask_for_user_input(&self) -> bool

pub fn set_quiet(&self) -> Self

impl<W: TerminalWriter> Terminal<W, ToStdErr>

pub fn write(&self, msg: impl AsRef<str>) -> Result<()>

pub fn rewrite(&self, msg: impl AsRef<str>) -> Result<()>

pub fn write_line(&self, msg: impl AsRef<str>) -> Result<&Self>

pub fn build_list( &self, items: &[impl Output], header: &str, empty_message: &str ) -> Result<String>

pub fn stdout(self) -> Terminal<W, ToStdOut>

impl<W: TerminalWriter> Terminal<W, ToStdOut>

pub fn is_tty(&self) -> bool

pub fn plain<T: Display>(self, msg: T) -> Self

pub fn machine<T: Display>(self, msg: T) -> Self

pub fn json<T: Display>(self, msg: T) -> Self

pub fn write_line(self) -> Result<()>

impl<W: TerminalWriter> Terminal<W>

pub fn progress_spinner(&self) -> Option<ProgressBar>

pub async fn progress_output( &self, output_messages: &Vec<String>, is_finished: &Mutex<bool> ) -> Result<()>

pub async fn progress_output_with_progress_bar( &self, output_messages: &Vec<String>, is_finished: &Mutex<bool>, progress_bar: Option<&ProgressBar> ) -> Result<()>

Trait Implementations§

impl<T: Clone + TerminalWriter, WriteMode: Clone> Clone for Terminal<T, WriteMode>

fn clone(&self) -> Terminal<T, WriteMode>

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl<W: TerminalWriter> Default for Terminal<W>

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

impl<T, WriteMode> RefUnwindSafe for Terminal<T, WriteMode>where T: RefUnwindSafe, WriteMode: RefUnwindSafe,

impl<T, WriteMode> Send for Terminal<T, WriteMode>where T: Send, WriteMode: Send,

impl<T, WriteMode> Sync for Terminal<T, WriteMode>where T: Sync, WriteMode: Sync,

impl<T, WriteMode> Unpin for Terminal<T, WriteMode>where T: Unpin, WriteMode: Unpin,

impl<T, WriteMode> UnwindSafe for Terminal<T, WriteMode>where T: UnwindSafe, WriteMode: UnwindSafe,

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<D> AsyncTryClone for Dwhere D: Clone + Sync,

fn async_try_clone<'life0, 'async_trait>( &'life0 self ) -> Pin<Box<dyn Future<Output = Result<D, Error>> + Send + 'async_trait>>where 'life0: 'async_trait, D: 'async_trait,

Try cloning a object and return an Err in case of failure.

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into for Twhere U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

Set the foreground color generically Read more

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

Set the background color generically. Read more

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized

fn blink<'a>(&'a self) -> BlinkDisplay<'a, Self>

Make the text blink

fn blink_fast<'a>(&'a self) -> BlinkFastDisplay<'a, Self>

Make the text blink (but fast!)

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more