Struct Store 

pub struct Store { /* private fields */ }

The records of one terminal. See the crate docs.

Implementations

impl Store

pub fn new() -> Self

A store with the spec’s full cap of 256 records.

pub fn with_capacity(capacity: usize) -> Self

A store holding at most capacity records, clamped to 64..=256 (terminals MAY choose a lower limit but MUST support at least 64).

pub fn set_drop_idle_on_lifetime_events(&mut self, on: bool)

Also drop idle records on process exit and new prompts (the spec allows either). Off by default.

pub fn capacity(&self) -> usize

The record cap.

pub fn len(&self) -> usize

Number of records.

pub fn is_empty(&self) -> bool

Whether there are no records.

pub fn get(&self, id: Option<&str>) -> Option<&Record>

The record for id (None is the root record).

pub fn iter(&self) -> impl Iterator<Item = (Option<&str>, &Record)>

All records, ordered by id with the root first.

pub fn effective_app(&self, id: Option<&str>) -> Option<&str>

The app of the record, or of its nearest ancestor record that has one. Ancestors do not need to exist. None if no record on the path carries an app.

pub fn apply(&mut self, message: &Message<'_>) -> Vec<Change>

Applies one decoded message. Feature-detection messages change nothing.

pub fn set(&mut self, report: &Report<'_>) -> Vec<Change>

Replaces the addressed record with report.

pub fn clear(&mut self, id: Option<&str>) -> Vec<Change>

Removes the record id and every record beneath it, or every record when id is None.

pub fn process_exited(&mut self) -> Vec<Change>

The process attached to the terminal exited: drops working and blocked records (and idle ones if so configured).

pub fn prompt_started(&mut self) -> Vec<Change>

A new shell prompt began (OSC 133 A): same effect as process_exited.

pub fn reset(&mut self) -> Vec<Change>

A full reset (RIS): removes every record. A soft reset (DECSTR) must not call this.

Trait Implementations

impl Clone for Store

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 Store

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

Formats the value using the given formatter.

impl Default for Store

fn default() -> Self

Returns the “default value” for a type.