Struct LogView 

pub struct LogView { /* private fields */ }

A live view of log records. See the module docs.

Implementations

impl LogView

pub const LIMIT: usize = 200_000

The records a view keeps by default before dropping the oldest.

pub fn new() -> LogView

An empty view.

pub fn records(self, records: impl IntoIterator<Item = Record>) -> LogView

Start with records.

pub fn source(self, source: Receiver<LogEvent>) -> LogView

Take records from source as they arrive, checking it every 100 ms until its sender is dropped.

pub fn collapse(self, on: bool) -> LogView

Fold runs of identical records into one row (default on).

pub fn time(self, mode: TimeMode) -> LogView

How times show (default as written).

pub fn expand_all(self, on: bool) -> LogView

Show every record’s fields, as if Enter had been pressed on each.

pub fn filter(self, filter: impl Into<String>) -> LogView

Start with this filter (see the module docs).

pub fn limit(self, records: usize) -> LogView

Keep at most records, dropping the oldest (default LIMIT).

pub fn theme(self, theme: Theme) -> LogView

pub fn len(&self) -> usize

The records received and kept.

pub fn is_empty(&self) -> bool

pub fn rows(&self) -> usize

The rows shown with the filter, a folded run counting once.

pub fn dropped(&self) -> usize

The records dropped past the limit.

pub fn is_following(&self) -> bool

Whether the view follows the end.

pub fn is_paused(&self) -> bool

pub fn filter_text(&self) -> &str

The filter typed.

pub fn push(&mut self, record: Record)

Add a record.

pub fn push_continuation(&mut self, line: String)

Add a line under the last record. Past Assembler::CONTINUATION_LIMIT lines it is only counted, and shown as … N more lines.

Trait Implementations

impl Component for LogView

fn prompt(&mut self, io: &mut dyn LineIo) -> Result<Option<()>, NotInteractive>

Without a terminal: every row, as text.

type Output = ()

fn start(&mut self, _context: &Context<'_>) -> Flow<()>

Called once, before the component is first painted, with the terminal’s size: for work that needs it, such as rendering content at the width. Returning Done or Cancel finishes the component without waiting for an event. The default does nothing.

fn handle(&mut self, event: &Event, context: &Context<'_>) -> Flow<()>

Handle one event. Ctrl+C never arrives here: the event loop ends the component with Outcome::Interrupted.

fn render(&self, context: &Context<'_>) -> View

Render the current state.

fn tick(&self) -> Option<Duration>

How often the component wants Event::Tick, for a spinner or a countdown. None (the default): never.

fn keymap(&self) -> Keymap

The bindings this component has right now, for a help overlay, a shortcut list or status-bar hints to read (see keymap). A container’s include its focused child’s, before its own. The default declares none.

fn default_value(&self) -> Option<()>

The value to return when the terminal is not interactive and the policy asks for defaults. None: there is none.

fn mouse(&self) -> bool

Whether the component wants mouse events (#476): clicks, drags and the wheel. Off by default, since reporting the mouse takes text selection away from the terminal; a component turns it on when its caller opts in, and run then enables mouse reporting for the session.

fn focusable(&self) -> bool

Whether the component takes focus in a container: Tab stops on it and keys go to it. The default: yes. A label, or a component that has finished, says no.

fn focus_step(&mut self, forward: bool) -> bool

Move focus to the next (forward) or previous focus stop inside this component, for Tab and Shift+Tab. false when there is none after the current one, so the container moves on to its next child. The default, for a component that is one stop: false.

fn focus_enter(&mut self, forward: bool) -> bool

Take focus from outside: at the first stop inside when forward, at the last otherwise. false when nothing in it can take focus. The default: whether the component is focusable.

impl Default for LogView

fn default() -> LogView

Returns the “default value” for a type.