Struct TranscriptLayout 

pub struct TranscriptLayout<'w, 's> { /* private fields */ }

Lays out an agent’s transcript as the terminal view draws it, without drawing it: for any agent, shown or not, in a run with the terminal or without, by the view’s own layout (its order, its renderers, wrapping and the matches it lights), so an export, a copy, a search or a screen reader reads what the view shows. Each layout renders and wraps the whole transcript, so lay one out when asked, not every frame. It is there in any run with the TuiPlugin, and takes the TranscriptView to lay out with, such as a pane’s, so a system that changes the view lays out with it too.

use rig_harness::prelude::*;
use rig_tui::{MainPane, TranscriptLayout, TranscriptView};

/// `/export`: the agent's transcript as the main pane draws it, a line
/// per row.
fn export(
    In(args): In<CommandArgs>,
    layout: TranscriptLayout,
    view: Single<&TranscriptView, With<MainPane>>,
) {
    let width = view.width().unwrap_or(100);
    let Some(laid_out) = layout.lay_out(&view, args.agent, width) else {
        return;
    };
    let rows: Vec<&str> = laid_out.rows().iter().map(|row| row.text.as_str()).collect();
    std::fs::write("transcript.txt", rows.join("\n")).ok();
}

Implementations

impl TranscriptLayout<'_, '_>

pub fn lay_out( &self, view: &TranscriptView, agent: Entity, width: u16, ) -> Option<DrawnTranscript>

agent’s transcript laid out in rows width columns wide (as TranscriptView::width says the view draws it; u16::MAX keeps a line in one row), the matches of view’s highlights counted, as the view would draw it with view. It has no rows on screen. DrawnTranscript::item takes one item’s rows out of it. None when agent is no agent.

Trait Implementations

impl<'w, 's> ReadOnlySystemParam for TranscriptLayout<'w, 's>

where Query<'w, 's, (&'static AgentId, &'static Conversation)>: ReadOnlySystemParam, Query<'w, 's, &'static ActiveTurn>: ReadOnlySystemParam, Query<'w, 's, &'static Calls>: ReadOnlySystemParam, Query<'w, 's, &'static Partial, Without<SupersededBy>>: ReadOnlySystemParam, Query<'w, 's, (&'static Effect, &'static Incoming, &'static ForAgent), (With<Started>, Without<Outcome>)>: ReadOnlySystemParam, Looks<'w, 's>: ReadOnlySystemParam, CallStates<'w, 's>: ReadOnlySystemParam, Query<'w, 's, (Entity, &'static Effect, (Option<&'static ToolRequest>, Option<&'static ModelRequest>, Option<&'static SentTo>), (Option<&'static ForAgent>, Option<&'static Outcome>), (Has<Started>, Has<Partial>)), Without<Settled>>: ReadOnlySystemParam, Query<'w, 's, &'static Name>: ReadOnlySystemParam, Res<'w, CallFacts>: ReadOnlySystemParam, Query<'w, 's, &'static StreamingCalls>: ReadOnlySystemParam, Res<'w, Notices>: ReadOnlySystemParam, Res<'w, Theme>: ReadOnlySystemParam,

impl SystemParam for TranscriptLayout<'_, '_>

type State = FetchState

Used to store data which persists across invocations of a system.

type Item<'w, 's> = TranscriptLayout<'w, 's>

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes.

fn init_state(world: &mut World) -> Self::State

Creates a new instance of this param’s State.

fn init_access( state: &Self::State, system_meta: &mut SystemMeta, system_access: &mut SystemAccess, world: &mut World, )

Registers any World access used by this SystemParam.

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during ApplyDeferred.

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_>, )

Queues any deferred mutations to be applied at the next ApplyDeferred.

unsafe fn get_param<'w, 's>( state: &'s mut Self::State, system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, change_tick: Tick, ) -> Result<Self::Item<'w, 's>, SystemParamValidationError>

Creates a parameter to be passed into a SystemParamFunction.