Struct Console 

pub struct Console<Ctx> { /* private fields */ }

Implementations

impl<Ctx: 'static> Console<Ctx>

pub fn new() -> Self

pub fn with_toggle_key(self, key: Key) -> Self

pub fn register<C: Command<Ctx> + 'static>(&mut self, command: C)

Silently replaces any existing command of the same name.

pub fn has_command(&self, name: &str) -> bool

pub fn bind(&mut self, key: Key, command_line: impl Into<String>)

No modifiers; fires only while the console is closed. Re-binding overwrites.

pub fn unbind(&mut self, key: Key)

pub fn open(&mut self)

pub fn close(&mut self)

pub fn toggle(&mut self)

pub fn is_open(&self) -> bool

pub fn detach(&mut self)

pub fn dock(&mut self)

pub fn is_detached(&self) -> bool

pub fn write(&mut self, line: HistoryLine)

pub fn set_status(&mut self, text: impl Into<String>)

pub fn toggle_key(&self) -> Key

pub fn binds(&self) -> impl Iterator<Item = (Key, &str)>

In Key order.

pub fn history(&self) -> &VecDeque<HistoryLine>

pub fn input(&self) -> &str

pub fn input_mut(&mut self) -> &mut String

An edit through this must be followed by Console::cancel_tab_cycle.

pub fn status(&self) -> &str

pub fn submit(&mut self)

pub fn clear_history(&mut self)

pub fn clear_input(&mut self)

pub fn cancel_tab_cycle(&mut self)

pub fn take_pending_focus(&mut self) -> bool

pub fn wants_persistent_focus(&self) -> bool

pub fn set_user_defocused(&mut self, defocused: bool)

pub fn take_pending_cursor_to_end(&mut self) -> bool

pub fn history_prev(&mut self)

pub fn history_next(&mut self)

pub fn tab_complete(&mut self)

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

Suffix of the first (sort-order) completion; what the next Tab inserts.

pub fn execute(&mut self, line: &str)

Runs a built-in on the spot; parks anything else for Console::drain_pending.

pub fn drain_pending(&mut self) -> Vec<String>

pub fn dispatch(&mut self, name: &str, args: &[&str], ctx: &mut Ctx)

Built-ins resolve here too, so a queued built-in runs like a typed one.

Trait Implementations

impl<Ctx: 'static> Default for Console<Ctx>

fn default() -> Self

Returns the “default value” for a type.