Struct Front 

pub struct Front {
    pub name: &'static str,
    pub terminal: bool,
    pub headless: bool,
    pub flag: Option<Flag>,
    pub command: Option<Command>,
    pub sessionless: bool,
    pub session_store: Option<StoreOpener>,
}

A front a plugin offers, and which runs it can take.

Fields

name: &'static str

Its name, which AppCliExt::runs_front asks about.

terminal: bool

Whether it takes a run on an interactive terminal. A command’s front that does not runs headless: the launcher passes its output and exit code through and never restarts it.

headless: bool

Whether it takes a run without one (--print, stdin piped in). This and terminal only pick the front of a run that names no command or option: a front with either takes only the runs that name it.

flag: Option<Flag>

The option that gives it the run, whatever the terminal.

command: Option<Command>

The command that gives it the run, whatever the terminal.

sessionless: bool

Whether its runs keep no session: a run it takes removes its session’s directory when it ends, and a resumed session’s run is refused.

session_store: Option<StoreOpener>

Where a run it takes keeps its session, in place of StoreOpener (Self::session_store).

Implementations

impl Front

pub fn new(name: &'static str) -> Self

A front that takes no run until told which.

pub fn on_terminal(self) -> Self

It takes a run on an interactive terminal.

pub fn headless(self) -> Self

It takes a run without an interactive terminal.

pub fn sessionless(self) -> Self

Its runs keep no session.

pub fn session_store( self, open: impl Fn(&SessionDir) -> Result<Arc<dyn Store>, SessionError> + Send + Sync + 'static, ) -> Self

A run it takes keeps its session in the store open opens for the session’s directory, such as one of a chat thread’s, instead of the one StoreOpener opens. Only the running session’s store comes from it: imports and listings still open theirs with StoreOpener. The front is chosen, and the store opened, once every plugin is built.

pub fn on_flag(self, flag: &'static str, help: &'static str) -> Self

It takes any run with --flag, an option it declares with help.

pub fn on_command( self, name: &'static str, usage: &'static str, help: &'static str, ) -> Self

It takes any run of rig <name> …, a command whose arguments are usage and which does what help says; the words after the name are read with Invoked::command. Two plugins with one command, or a command of the launcher’s own name, fail the build.

Trait Implementations

impl Clone for Front

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 Front

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 Front

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

Formats the value using the given formatter.