Struct BusPlugin 

pub struct BusPlugin {
    pub policy: ServingPolicy,
    pub ambiguity: LogLevel,
    pub idle: Duration,
}

The bus: RigSchedule with its sets and systems after Update, the counters, the handler table, the observers, the Wake and its runner.

The task pool: build calls IoTaskPool::get_or_init, so the bus works with or without a host that initialises the pools itself.

Fields

policy: ServingPolicy

The serving policy: intake per tick, serial keys and bounded delivery. stream_capacity supplies shared queue slots, clamped to at least one; the single sender has one additional reserved slot.

ambiguity: LogLevel

Schedule ambiguity detection level, defaulting to Warn.

idle: Duration

How long the default runner waits for a wake before updating anyway.

Implementations

impl BusPlugin

pub fn with_policy(policy: ServingPolicy) -> Self

The bus under policy.

pub fn ambiguity_detection(self, level: LogLevel) -> Self

Build the schedule with ambiguity detection at level.

pub fn install(&self, world: &mut World)

Install resources, observers, RigSchedule, and RigEnd in world. Panics if the bus is already installed. Does not configure an app runner; callers driving a bare world must run the schedules themselves.

Trait Implementations

impl Clone for BusPlugin

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BusPlugin

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

Formats the value using the given formatter.

impl Default for BusPlugin

fn default() -> Self

Returns the “default value” for a type.

impl Plugin for BusPlugin

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.