Skip to main content

StringOutput

Struct StringOutput 

Source
pub struct StringOutput { /* private fields */ }
Expand description

In-memory Output implementation for use in tests.

All output is appended to an internal String. Call StringOutput::log to retrieve the full captured output and assert on it.

use jt_consoleutils::output::{Output, StringOutput};

let mut out = StringOutput::new();
out.writeln("hello");
assert_eq!(out.log(), "hello\n");

Implementations§

Source§

impl StringOutput

Source

pub fn new() -> Self

Create a new, empty StringOutput.

Source

pub fn log(&self) -> &str

Return the full captured output as a string slice.

Trait Implementations§

Source§

impl Default for StringOutput

Source§

fn default() -> Self

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

impl Output for StringOutput

Source§

fn writeln(&mut self, line: &str)

Write line followed by a newline. Suppressed in quiet mode.
Source§

fn write(&mut self, text: &str)

Write text without a trailing newline. Suppressed in quiet mode.
Source§

fn verbose(&mut self, f: Box<dyn FnOnce() -> String>)

Emit a lazily-evaluated message, only in verbose mode. Read more
Source§

fn shell_command(&mut self, cmd: &str)

Echo a shell command about to be run (verbose mode only).
Source§

fn shell_line(&mut self, line: &str)

Echo a single line of output from a running shell command.
Source§

fn step_result( &mut self, label: &str, success: bool, elapsed_ms: u128, _viewport: &[String], )

Render the result of a completed step: a tick/cross, label, elapsed time, and (on failure) the last few lines of output from the viewport.
Source§

fn dry_run_shell(&mut self, cmd: &str)

Dry-run: announce a shell command that would be executed.
Source§

fn dry_run_write(&mut self, path: &str)

Dry-run: announce a file that would be written.
Source§

fn dry_run_delete(&mut self, path: &str)

Dry-run: announce a file or directory that would be deleted.
Source§

fn log(&mut self, mode: OutputMode, msg: &str)

Log a message in verbose mode without any extra ceremony.
Source§

fn log_exec(&mut self, mode: OutputMode, cmd: &Command)

Log a command about to be executed (verbose mode).

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.