Struct dbgcmd::Console

pub struct Console { /* fields omitted */ }

Methods

impl Console

pub fn new() -> Self

impl Console

pub const fn enabled(&self) -> bool

Whether the console is enabled. This will be false in release mode unless the force-enabled feature is switched on.

When this is false, all methods of the Console struct will do nothing and return only default values.

pub fn confirm<Cmd: FromStr>(&mut self) -> Result<Cmd, Cmd::Err>

Tries to parse the text entered so far as the given type, and clear the entry.

This uses the FromStr trait to parse the entry. You should implement this trait on the type you're using for your commands.

pub fn entry(&self) -> &str

Returns a reference to the text entered so far.

pub fn history(&self) -> impl Iterator<Item = &str>

Returns an iterator over the previously confirmed entries. This yields items in the order from most recent to least recent.

pub fn history_deduped(&self) -> impl Iterator<Item = &str>

The same as history, but will not yield the same entry twice in a row.

pub fn history_len(&self) -> usize

Returns the number of items in the history. Note that this includes duplicate entries.

pub fn set_entry(&mut self, entry: String)

Clears and sets the value of the entire command entry.

pub fn receive_char(&mut self, ch: char)

Receive an individual character and append it to the command entry.

pub fn receive_char_if<F: Fn(char) -> bool>(
    &mut self,
    ch: char,
    filter: F
) -> bool

Receive an individual character and append it to the command entry if the filter argument returns true for it.

Useful for limiting which characters can be entered.

Examples

let mut console = dbgcmd::Console::new();

let ch = '?';
let accepted = console.receive_char_if(ch, char::is_alphanumeric);

assert!(!accepted);
assert!(console.entry().is_empty());

pub fn backspace(&mut self)

Removes the last character of the command entry.

pub fn clear(&mut self)

Clears the command entry.

pub fn clear_history(&mut self)

Clears the entire command history.

pub fn up(&mut self) -> bool

Cycles through the command history towards older entries.

Returns true if there was an older entry, and false if not. If there is no older entry, the cursor does not move.

pub fn up_deduped(&mut self) -> bool

Cycles through the command history towards older entries, ignoring duplicates.

Returns true if there was an older entry that differs from the current entry.

pub fn down(&mut self) -> bool

Cycles through the command history towards newer entries.

Returns true if there was a newer entry, including the current input. Returns false if there was no newer entry.

pub fn down_deduped(&mut self) -> bool

Cycles through the command history towards newer entries, ignoring duplicates.

Returns true if there was a newer entry that differs from the current entry.

pub fn shown(&self) -> bool

Whether or not the Console is in a visible state. This does not affect the functionality of any other method, and is intended to be used by you to decide whether or not to render the console.

pub fn show(&mut self)

Sets the Console to be visible.

pub fn hide(&mut self)

Sets the Console to be hidden.

pub fn toggle_shown(&mut self)

Toggles the visible state of the Console.

Trait Implementations

impl Clone for Console

fn clone(&self) -> Console

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Console

fn default() -> Console

Returns the "default value" for a type.

impl Eq for Console

impl PartialEq<Console> for Console

fn eq(&self, other: &Console) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Console) -> bool

This method tests for !=.

impl StructuralEq for Console

impl StructuralPartialEq for Console