Struct PendingInput 

pub struct PendingInput(pub Vec<KeyInput>);

The frame’s input, in order: what the terminal reported and the actions plugins pushed. The view does one item at a time, running TuiKeys for each: InputSystems::Filter systems may change, drop or replace it (with the main Editor and InputContext as the keys before it left them), and InputSystems::Dispatch does it. The picker or question shown takes it first, then a KeyBinding, then the input. Items left by a run are done next; a push outside TuiKeys waits for the next frame.

use rig_harness::prelude::*;
use rig_tui::crossterm::event::{Event, KeyCode};
use rig_tui::{Editor, InputSystems, KeyInput, MainEditor, PendingInput, InputContext, TuiKeys};

/// `/` on an empty input opens a search instead of a slash command.
fn slash_searches(
    mut events: ResMut<PendingInput>,
    input: Single<&Editor, With<MainEditor>>,
    state: Res<InputContext>,
) {
    let slash = |item: &KeyInput| {
        matches!(item, KeyInput::Event(Event::Key(key)) if key.code == KeyCode::Char('/'))
    };
    if input.is_empty() && state.picking().is_none() && events.0.first().is_some_and(slash) {
        events.0.remove(0);
        // open the search
    }
}

fn build(app: &mut App) {
    app.add_systems(TuiKeys, slash_searches.in_set(InputSystems::Filter));
}

Tuple Fields

0: Vec<KeyInput>

Trait Implementations

impl Clone for PendingInput

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for PendingInput

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

impl Debug for PendingInput

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

Formats the value using the given formatter.

impl Default for PendingInput

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PendingInput

impl PartialEq for PendingInput

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

Equality operator ==.

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

Inequality operator !=.

impl Resource for PendingInput

where Self: Send + Sync + 'static,

impl StructuralPartialEq for PendingInput