Skip to main content

DevConsole

Struct DevConsole 

Source
pub struct DevConsole {
    pub filter: ConsoleFilter,
    pub registry: CommandRegistry,
    pub state: ConsoleState,
    pub history: CommandHistory,
    pub complete: CommandAutoComplete,
    pub input_buffer: String,
    pub cursor_visible: bool,
    pub scroll_offset: usize,
    /* private fields */
}
Expand description

The developer console: log viewer + command input.

Fields§

§filter: ConsoleFilter§registry: CommandRegistry§state: ConsoleState§history: CommandHistory§complete: CommandAutoComplete§input_buffer: String

Current text in the input field.

§cursor_visible: bool

Blinking cursor state.

§scroll_offset: usize

How many lines we’ve scrolled back from the bottom.

Implementations§

Source§

impl DevConsole

Source

pub fn new() -> Self

Source

pub fn log(&mut self, level: LogLevel, text: impl Into<String>)

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn lines(&self) -> impl Iterator<Item = &ConsoleLine>

Source

pub fn line_count(&self) -> usize

Source

pub fn clear_log(&mut self)

Source

pub fn push_char(&mut self, c: char)

Source

pub fn pop_char(&mut self)

Source

pub fn clear_input(&mut self)

Source

pub fn submit(&mut self) -> CommandOutput

Submit the current input buffer as a command.

Source

pub fn tab_complete(&mut self)

Attempt tab-completion on the current input.

Source

pub fn history_up(&mut self)

Source

pub fn history_down(&mut self)

Source

pub fn scroll_up(&mut self, lines: usize)

Source

pub fn scroll_down(&mut self, lines: usize)

Source

pub fn scroll_to_bottom(&mut self)

Source

pub fn tick(&mut self, dt: f32)

Source

pub fn drain_sink(&mut self, sink: &ConsoleSink)

Drain a ConsoleSink into this console.

Trait Implementations§

Source§

impl Default for DevConsole

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,