Struct JSONConsoleRenderer 

pub struct JSONConsoleRenderer { /* private fields */ }

A simple JSON based console renderer.

Implementations

impl JSONConsoleRenderer

pub fn new() -> Self

Create a simple JSON console renderer.

Trait Implementations

impl ConsoleRenderer for JSONConsoleRenderer

fn clear_input(&self, _term_width: u16) -> String

We actually pause rendering so we don’t need to do any ‘clear’-ing

fn clear_task_list(&self, _task_list_size: usize) -> String

We don’t need to do any ‘clear’-ing

fn render_input( &self, _app_name: &'static str, _provider: &dyn InputProvider, _term_width: u16, ) -> Result<String, LisaError>

Render a dynamic input line.

We actually don’t render a dynamic input, as that’d require erasing things, and that can’t be done in a TEXT mode, or supported in a braille display.

We actually only render when Self::on_input is called. As inputs are paused anyway clear/render is never called.

Errors

This function will never error.

fn rerender_tasks( &self, new_task_events: &[TaskEvent], _current_task_states: &FnvHashMap<GloballyUniqueTaskId, (DateTime<Utc>, String, LisaTaskStatus)>, _running_since: Option<DateTime<Utc>>, _term_height: u16, ) -> Result<String, LisaError>

Re-render all the tasks as new events come in.

For this will just render any new events that come in between the last time we called it.

fn on_input( &self, event: TerminalInputEvent, provider: &dyn InputProvider, ) -> Result<String, LisaError>

Handle a user typing into the terminal.

This will simply render the actual input line, and characters as users type.

Errors

Never.

fn should_use_renderer( &self, _features: &dyn ConsoleOutputFeatures, environment_prefix: &str, ) -> bool

Get a renderer if it is compatible, and should be used with a set of stream features.

fn render_message( &self, _app_name: &'static str, log: SuperConsoleLogMessage, term_width: u16, ) -> Result<String, LisaError>

Render a log message.

fn default_ps1(&self) -> String

Get the default PS1 to use for this renderer, if none was provided.

fn update_ps1(&self, new_ps1: String)

Update the ‘PS1’, or characters the get rendered before typing in a command.

fn supports_ansi(&self) -> bool

Return if this renderer supports ‘cursor movement’, using ANSI escape codes or similar to move the cursor.

fn should_pause_log_events(&self, provider: &dyn InputProvider) -> bool

A flag used to ‘pause’ rendering log events for awhile.

impl Debug for JSONConsoleRenderer

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

Formats the value using the given formatter.

impl Default for JSONConsoleRenderer

fn default() -> Self

Returns the “default value” for a type.