Skip to main content

CommandLogs

Struct CommandLogs 

Source
pub struct CommandLogs {
    pub entries: Vec<CommandLogEntry>,
    pub scroll: u16,
    pub max_scroll: u16,
    pub x_scroll: u16,
    pub max_x_scroll: u16,
}
Expand description

Owned state for the Command Logs overlay: the snapshotted entries and the (vertical + horizontal) scroll cursor with its renderer-published bounds.

Fields§

§entries: Vec<CommandLogEntry>

Snapshot of the global command log, oldest-first (the renderer paints it newest-first). Refreshed by Self::sync.

§scroll: u16

Vertical scroll offset, in rows. Clamped to max_scroll.

§max_scroll: u16

Maximum vertical scroll offset, republished by the renderer each frame as content_rows.saturating_sub(viewport_rows).

§x_scroll: u16

Horizontal scroll offset, in columns. Clamped to max_x_scroll.

§max_x_scroll: u16

Maximum horizontal scroll offset, republished by the renderer.

Implementations§

Source§

impl CommandLogs

Source

pub fn new() -> Self

An empty overlay at the origin.

Source

pub fn sync(&mut self)

Copy the global command log into Self::entries. Cheap clone of a bounded ring (≤ command_log::MAX_ENTRIES); called on open and per tick while the overlay is up so it tracks commands that finish (e.g. an off-thread GitHub fetch) while the user is reading.

Source

pub fn scroll_down(&mut self)

Scroll down one row, never past the last line.

Source

pub fn scroll_up(&mut self)

Scroll up one row, never above the top.

Source

pub fn scroll_right(&mut self)

Scroll right one column, never past the widest line.

Source

pub fn scroll_left(&mut self)

Scroll left one column, never before the first.

Source

pub fn scroll_to_top(&mut self)

Jump to the first row (g).

Source

pub fn scroll_to_bottom(&mut self)

Jump to the last row (G).

Source

pub fn reset(&mut self)

Reset the scroll cursor to the origin, keeping the snapshotted entries. Called when the overlay opens.

Trait Implementations§

Source§

impl Debug for CommandLogs

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CommandLogs

Source§

fn default() -> CommandLogs

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.