Struct SuperConsole 

pub struct SuperConsole<StdoutTy: ConsoleOutputFeatures + IoWrite + Send + 'static, StderrTy: ConsoleOutputFeatures + IoWrite + Send + 'static> { /* private fields */ }

Effectively the console “renderer”.

SuperConsole is responsible for keeping track of the ‘rendering’ state, and managing it effectively. This crucially does not handle any of the input tracking or any of the other console related bits.

It is called SuperConsole as it’s output is heavily inspired by the Buck1 renderer also with the name SuperConsole. Buck2 also has a concept of a SuperConsole, but I don’t like it’s output at all. So don’t confuse it with the rust library ‘superconsole’, or it’s buck2 counterpart.

Implementations

impl SuperConsole<Stdout, Stderr>

pub fn new(app_name: &'static str) -> Result<Self, LisaError>

Create a new super console that will print to the programs STDOUT/STDERR.

This will dynamically choose a renderer to use based off the default renderers that are present in lisa (color, json, and text).

Errors

If we could not identify a renderer to use, If we cannot spawn a background task to render inputs.

pub fn new_preselected_renderers( app_name: &'static str, stdout_renderer: Box<dyn ConsoleRenderer>, stderr_renderer: Box<dyn ConsoleRenderer>, ) -> Result<Self, LisaError>

Create a new super console that will print to the programs STDOUT/STDERR.

In this case the renderers are explicitly passed in allowing for fully custom rendering. It is the callers job to make sure that they have respected all and any user preferences for which renderer they want to use.

Errors

If we cannot spawn a background task to render inputs.

impl<StdoutTy: ConsoleOutputFeatures + IoWrite + Send + 'static, StderrTy: ConsoleOutputFeatures + IoWrite + Send + 'static> SuperConsole<StdoutTy, StderrTy>

pub fn new_with_outputs( app_name: &'static str, stdout: StdoutTy, stderr: StderrTy, ) -> Result<Self, LisaError>

Create a new super console where outputs go somewhere specific (may not be stdout/stderr).

Errors

If we cannot find a renderer for your given stdout/stderr types, or cannot spawn a background task to progress the input.

pub fn new_with_outputs_and_preselected_renderers( app_name: &'static str, stdout: StdoutTy, stderr: StderrTy, stdout_renderer: Box<dyn ConsoleRenderer>, stderr_renderer: Box<dyn ConsoleRenderer>, ) -> Result<Self, LisaError>

Create a new console outputting to specific places, with specific renderers.

It is up to the caller to inherit all user preferences for the renderers.

Errors

If we cannot spawn a task to tick along the console.

pub async fn flush(&self)

Request this console immediately working on flushing it’s contents.

THIS WILL NOT RETURN UNTIL THE FLUSH HAS BEEN COMPLETED.

pub fn get_render_state( &self, ) -> MutexGuard<'_, RawMutex, UnlockedRendererState<StdoutTy, StderrTy>>

Get the current render state.

NOTE: WHILE HOLDING TO THIS YOU WILL BE LOCKING LOGS FROM RENDERING.

pub fn set_input_provider<Ty: InputProvider + Sized + 'static>( &self, provider: Ty, )

Set the current input provider.

pub fn set_task_provider<Ty: TaskEventLogProvider + Sized + 'static>( &self, provider: Ty, )

Set the current event log task provider.

pub fn set_input_channel(&self, channel: BoundedSender<String>)

Set a channel to receive inputs on rather than needing to call Self::get_unprocessed_inputs.

pub fn set_input_active(&self, active: bool) -> Result<(), LisaError>

Mark the current input as active.

Errors

If the input provider errors trying to be marked as active.

pub fn get_unprocessed_inputs(&self) -> Vec<String>

Get a series of unprocessed inputs from the input provider.

In general prefer using Self::set_input_channel which gives you a channel you can poll for inputs with locking this like with poll for inputs, and rendering.

pub fn choose_default_renderer( features: &dyn ConsoleOutputFeatures, environment_prefix: &str, ) -> Option<Box<dyn ConsoleRenderer>>

Look at all the default renderers, and return whichever one is compatible if any are.

pub fn terminal_height_and_width() -> Option<(u16, u16)>

Cross OS wrapper for getting the current terminal height & width.

This backs off of termios on many non-windows OS, and then GetConsoleScreenBufferInfo on windows. This will look at standard in file descriptor (as standard out/standard error can be individually redirected).

pub fn terminal_height() -> Option<u16>

Cross OS wrapper for getting the current terminal height.

This backs off of termios on many non-windows OS, and then GetConsoleScreenBufferInfo on windows. This will look at standard in file descriptor (as standard out/standard error can be individually redirected).

pub fn terminal_width() -> Option<u16>

Cross OS wrapper for getting the current terminal width.

This backs off of termios on many non-windows OS, and then GetConsoleScreenBufferInfo on windows. This will look at standard in file descriptor (as standard out/standard error can be individually redirected).

Trait Implementations

impl<StdoutTy: ConsoleOutputFeatures + IoWrite + Send, StderrTy: ConsoleOutputFeatures + IoWrite + Send> Drop for SuperConsole<StdoutTy, StderrTy>

fn drop(&mut self)

Executes the destructor for this type.