Struct branchless::core::effects::Effects

pub struct Effects { /* private fields */ }

Wrapper around side-effectful operations, such as output and progress indicators.

Implementations

impl Effects

pub fn new(glyphs: Glyphs) -> Self

Constructor. Writes to stdout.

pub fn new_suppress_for_test(glyphs: Glyphs) -> Self

Constructor. Suppresses all output.

pub fn new_from_buffer_for_test( glyphs: Glyphs, stdout: &Arc<Mutex<Vec<u8>>>, stderr: &Arc<Mutex<Vec<u8>>> ) -> Self

Constructor. Writes to the provided buffer.

pub fn enable_tui_mode(&self) -> Self

Send output to an appropriate place when using a terminal user interface (TUI), such as for git undo.

pub fn suppress(&self) -> Self

Suppress output sent to the returned Effects.

pub fn reverse_order(&self, reverse: bool) -> Self

Apply transformations to the returned Effects to support emitting graphical output in the opposite of its usual order.

pub fn start_operation( &self, operation_type: OperationType ) -> (Effects, ProgressHandle<'_>)

Start reporting progress for the specified operation type.

A progress spinner is shown until the returned ProgressHandle is dropped, at which point the spinner transitions to a “complete” message.

Progress spinners are nested hierarchically. If this function is called while another ProgressHandle is still alive, then the returned ProgressHandle will be a child of the first handle.

None of the progress indicators are cleared from the screen until all of the operations have completed. Furthermore, their internal timer is not reset while they are still on the screen.

If you finish and then start the same operation type again while it is still displayed, then it will transition back into the “progress” state, and its displayed duration will start increasing from its previous value, rather than from zero. The practical implication is that you can see the aggregate time it took to carry out sibling operations, i.e. the same operation called multiple times in a loop.

pub fn get_glyphs(&self) -> &Glyphs

Get the set of glyphs associated with the output.

pub fn get_output_stream(&self) -> OutputStream

Create a stream that can be written to. The output might go to stdout or be rendered specially in the terminal.

pub fn get_error_stream(&self) -> ErrorStream

Create a stream that error output can be written to, rather than regular output.

Trait Implementations

impl Clone for Effects

fn clone(&self) -> Effects

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Effects

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.