Struct State 

pub struct State { /* private fields */ }

Available on crate feature log-viewer only.

The kept entries, the filters, the search, the selection and whether the log follows its newest line.

Implementations

impl State

pub fn new() -> Self

An empty log that keeps DEFAULT_LIMIT entries, shows every level and follows the newest line.

pub fn with_limit(self, limit: usize) -> Self

Keeps at most limit entries, dropping the oldest. A limit of zero is treated as one.

pub fn with_levels(self, levels: impl IntoIterator<Item = Level>) -> Self

Shows only the given levels.

pub fn with_wrap(self, wrap: bool) -> Self

Starts with long lines wrapped.

pub fn with_search_id(self, id: impl Into<Id>) -> Self

Replaces SEARCH_ID, so several logs on one screen each focus their own field.

pub fn extend(&mut self, entries: impl IntoIterator<Item = Entry>)

Appends entries straight away, as the channel does.

pub fn entries(&self) -> impl Iterator<Item = &Entry>

Every kept entry, oldest first, whether shown or not.

pub fn len(&self) -> usize

How many entries are kept.

pub fn is_empty(&self) -> bool

pub fn limit(&self) -> usize

pub fn entry(&self, id: LineId) -> Option<&Entry>

The entry with id, if it is still kept.

pub fn visible(&self) -> impl Iterator<Item = LineId> + '_

The ids of the lines shown, oldest first.

pub fn visible_len(&self) -> usize

How many lines are shown.

pub fn count(&self, level: Level) -> usize

How many kept entries have this level.

pub fn is_shown(&self, level: Level) -> bool

pub fn levels(&self) -> &State<Level>

The level filters as a multiple-choice toggle group, each labelled with its level’s count.

pub fn query(&self) -> &str

pub fn matches(&self) -> impl Iterator<Item = LineId> + '_

The shown lines whose message matches the search, oldest first.

pub fn match_count(&self) -> usize

pub fn current_match(&self) -> Option<(LineId, usize)>

The match the search last moved to, and its position counted from one, if it is still shown.

pub fn is_selected(&self, id: LineId) -> bool

pub fn selected(&self) -> Vec<LineId>

The selected lines that are shown, oldest first.

pub fn highlighted(&self) -> Option<LineId>

The line the keyboard acts on.

pub fn is_focused(&self) -> bool

pub fn is_following(&self) -> bool

pub fn is_paused(&self) -> bool

pub fn pending(&self) -> usize

Entries held back while paused.

pub fn unseen(&self) -> usize

Lines that arrived since the log stopped following.

pub fn is_wrapped(&self) -> bool

pub fn search_id(&self) -> &Id

pub fn can_copy(&self) -> bool

Whether there is anything to copy: a shown selected line or a highlight.

pub fn copy_text(&self) -> Option<String>

The selected lines as text, one per line, or the highlighted line when nothing is selected.

pub fn update(&mut self, event: Event) -> Option<Output>

Applies an event and returns what the app may need to act on.

pub fn key_event(&self, keymap: &Keymap<Action>, key: &Event) -> Option<Event>

Turns a key press into an event through keymap.

Trait Implementations

impl Clone for State

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for State

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

Formats the value using the given formatter.

impl Default for State

fn default() -> Self

Returns the “default value” for a type.