Struct CallOutput 

pub struct CallOutput { /* private fields */ }

On a running call: the output its tool reports as it runs, through the Live it was made with. The harness keeps the call’s ToolProgress (its last line) and its IfStopped (the output so far, cut as tool output is cut, then [stopped before it finished]) current from it, in Stage::Arrive, so a call that is stopped answers with what it printed. The shell tool reports this way; a tool of your own does too:

use rig_harness::prelude::*;

/// Gives each `build` call a `Live` its tool writes its output to.
fn follow_builds(
    calls: Query<(Entity, &ToolRequest), (ToolCalls, Added<Admitted>)>,
    wake: Res<Wake>,
    mut commands: Commands,
) {
    for (call, request) in &calls {
        if request.call.function.name.as_str() == "build" {
            let (output, _live) = CallOutput::new(&wake);
            commands.entity(call).insert(output);
            // The call's handler, built with `_live` in `PrepareSystems::Edit`,
            // calls `_live.line(..)` as it works.
        }
    }
}

Implementations

impl CallOutput

pub fn new(wake: &Wake) -> (Self, Live)

A call’s output, and the Live its tool reports into; each piece wakes the app.

pub fn text(&self) -> String

The output so far, cut as tool output is cut: its last lines, after a line saying how many earlier ones were left out.

Trait Implementations

impl Component for CallOutput

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 CallOutput

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

Formats the value using the given formatter.