Struct ForceFailureNode 

pub struct ForceFailureNode { /* private fields */ }

Always reports Failure once its child resolves, regardless of whether the child actually succeeded or failed; Running passes through unchanged. The mirror of ForceSuccessNode, useful inside a Selector to force a fallback to the next option.

Implementations

impl ForceFailureNode

pub fn new(child: Box<dyn BehaviorNode>) -> ForceFailureNode

Create a new force-failure node wrapping child.

Trait Implementations

impl BehaviorNode for ForceFailureNode

fn tick<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 Context, ) -> Pin<Box<dyn Future<Output = Result<NodeStatus, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, ForceFailureNode: 'async_trait,

Execute one tick of the behavior. Called repeatedly by the execution engine; should perform one unit of work, return quickly, and report progress via NodeStatus.

fn name(&self) -> &str

Get the name of this behavior node.

fn children_mut(&mut self) -> Vec<&mut dyn BehaviorNode>

Return mutable references to this node’s child behaviors, in the order they should receive lifecycle events. Leaf nodes should not override this; composite nodes override it to expose their children.

fn active_capability(&self) -> Option<&str>

The capability this node implies should be published on /behavior/status while it’s actively being ticked; None for nodes with no such gate (the default). Composite nodes override this to forward whichever child is currently active.

fn reset_self(&mut self)

Reset this node’s own local state, ignoring children.

fn reset<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Reset the behavior to its initial state.

fn on_init<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 Context, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Called when the behavior is first initialized.

fn on_terminate<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 Context, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Called when the behavior is being terminated.

impl Debug for ForceFailureNode

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

Formats the value using the given formatter.