Struct Chain 

pub struct Chain { /* private fields */ }

Implementations

impl Chain

pub fn new(commands: impl IntoIterator<Item = LocalCommand>) -> Self

Examples found in repository

examples/simple_chain.rs (lines 17-21)

fn setup(mut commands: Commands) {
    // Create a chain of commands
    #[cfg(not(windows))]
    let chain = Chain::new(vec![
        LocalCommand::new("sh").args(["-c", "echo 'First command' && sleep 1"]),
        LocalCommand::new("sh").args(["-c", "echo 'Second command' && sleep 1"]),
        LocalCommand::new("sh").args(["-c", "echo 'Third command' && sleep 1"]),
    ]);
    #[cfg(windows)]
    let chain = Chain::new(vec![
        LocalCommand::new("powershell").args(["echo 'First command' && sleep 1"]),
        LocalCommand::new("powershell").args(["echo 'Second command' && sleep 1"]),
        LocalCommand::new("powershell").args(["echo 'Third command' && sleep 1"]),
    ]);

    // Spawn an entity with the Chain component
    let id = commands.spawn(chain).id();
    println!("Spawned the chain as entity {id:?}");
}

examples/chain_failure_delay_retries.rs (lines 20-24)

fn setup(mut commands: Commands) {
    // Spawn an entity with the relevant components
    #[cfg(not(windows))]
    let chain = Chain::new(vec![
        LocalCommand::new("sh").args(["-c", "echo 'First command'"]),
        LocalCommand::new("sh").args(["-c", "exit 1"]), // Failure
        LocalCommand::new("sh").args(["-c", "echo 'Third command'"]),
    ]);
    #[cfg(windows)]
    let chain = Chain::new(vec![
        LocalCommand::new("powershell").args(["echo 'First command'"]),
        LocalCommand::new("powershell").args(["exit 1"]), // Failure
        LocalCommand::new("powershell").args(["echo 'Third command'"]),
    ]);
    let id = commands
        .spawn((
            chain,
            Retry::Attempts(2),
            Delay::Fixed(Duration::from_secs(2)),
        ))
        .id();
    println!("Spawned the chain as entity {id:?}");
}

examples/chain_retries_delay_cleanup.rs (lines 20-24)

fn setup(mut commands: Commands) {
    // Spawn a entity with all addons
    #[cfg(not(windows))]
    let chain = Chain::new(vec![
        LocalCommand::new("sh").args(["-c", "echo 'First command'"]),
        LocalCommand::new("sh").args(["-c", "echo 'Second command'"]),
        LocalCommand::new("sh").args(["-c", "echo 'Third command'"]),
    ]);
    #[cfg(windows)]
    let chain = Chain::new(vec![
        LocalCommand::new("powershell").args(["echo 'First command'"]),
        LocalCommand::new("powershell").args(["echo 'Second command'"]),
        LocalCommand::new("powershell").args(["echo 'Third command'"]),
    ]);
    let id = commands
        .spawn((
            chain,
            Retry::Attempts(2),
            Delay::Fixed(Duration::from_secs(3)),
            Cleanup::RemoveComponents,
        ))
        .id();
    println!("Spawned as entity {id:?}");
}

examples/chain_failure.rs (lines 17-23)

fn setup(mut commands: Commands) {
    // Create a chain of commands
    #[cfg(not(windows))]
    let chain = Chain::new(vec![
        LocalCommand::new("sh").args(["-c", "echo 'First command' && sleep 1"]),
        LocalCommand::new("commanddoesnotexist").args(["this should fail"]), // Failure
        LocalCommand::new("sh").args(["-c", "echo 'Third command' && sleep 1"]),
        // Same result with a failed running command
        //LocalCommand::new("sh").args(["-c", "exit 1"]), // Failure
    ]);
    #[cfg(windows)]
    let chain = Chain::new(vec![
        LocalCommand::new("powershell").args(["echo 'First command' && sleep 1"]),
        LocalCommand::new("commanddoesnotexist").args(["this should fail"]), // Failure
        LocalCommand::new("powershell").args(["echo 'Third command' && sleep 1"]),
        // Same result with a failed running command
        //LocalCommand::new("powershell").args(["exit 1"]), // Failure
    ]);

    // Spawn an entity with the Chain component
    let id = commands.spawn(chain).id();
    println!("Spawned the chain as entity {id:?}");
}

Trait Implementations

impl Component for Chain

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 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_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace 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]