Struct CompletionSource 

pub struct CompletionSource {
    pub trigger: CompletionTrigger,
    pub candidates: Vec<Candidate>,
}

Candidates a plugin adds to completion, on an entity of its own: for a word starting with a marker anywhere in the input, such as # for issues (CompletionSource::marker), or for an argument of a slash command, such as /model’s models (CompletionSource::arg). The view itself completes / at the start to a command name and @ to a path of the ProjectRoot (walked off the main thread, honouring .gitignore, until a FileWatch of the root sees a change).

A candidate matches when it contains the word typed, ignoring case; the earlier the match, the higher it ranks. Several sources for one trigger add up; keep one current by inserting it again, such as when a lookup of what is typed (InputContext::typed) finished: an open list follows.

use rig_harness::prelude::*;
use rig_tui::CompletionSource;

fn offer(mut commands: Commands) {
    let branches = CompletionSource::arg("checkout").candidate("main", "").candidate("dev", "2 ahead");
    let issues = CompletionSource::marker('#').candidate("142", "Crash on empty input");
    commands.spawn_batch([branches, issues]);
}

Fields

trigger: CompletionTrigger

What it completes.

candidates: Vec<Candidate>

The candidates, in the order they are listed when they match alike.

Implementations

impl CompletionSource

pub fn marker(marker: char) -> Self

No candidates yet for a word starting with marker.

pub fn arg(command: impl Into<String>) -> Self

No candidates yet for command’s first argument.

pub fn at(self, at: usize) -> Self

The same, completing the argument at position (from 0) instead; a marker’s source is left as it is.

pub fn candidate( self, text: impl Into<String>, detail: impl Into<String>, ) -> Self

The same, also offering text, described by detail (may be empty).

Trait Implementations

impl Clone for CompletionSource

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 CompletionSource

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

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 CompletionSource

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

Formats the value using the given formatter.

impl Eq for CompletionSource

impl PartialEq for CompletionSource

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CompletionSource