Struct DrawnTranscript 

pub struct DrawnTranscript { /* private fields */ }

The transcript as the view drew it at its last frame: every row laid out, on screen or not, as drawn (wrapped, as its renderer drew it), with the items they belong to and the matches the view lit in each. A plugin counts and scrolls over this, not over the source text. TranscriptLayout lays one out without drawing it, for any agent; a plugin’s test, with no terminal to draw, inserts such a one as this resource.

It costs nothing until a plugin adds it to a pane. From then on, each frame that lays out the pane, in TuiSystems::Layout, copies the text of every row of it, and with TranscriptView::highlights set counts their matches in each, so its work and memory grow with the transcript; a streaming reply draws at most about 30 frames a second. Frames that draw the same rows leave it unchanged, so Ref::is_changed says what is drawn changed.

use rig_harness::prelude::*;
use rig_tui::{DrawnTranscript, ItemRow, ScrollTo, TranscriptItem};

/// Shows the first item with a lit match, by its first one.
fn first_match(panes: Query<(Entity, Ref<DrawnTranscript>)>, mut commands: Commands) {
    for (pane, drawn) in panes.iter().filter(|(_, drawn)| drawn.is_changed()) {
        let mut lit = drawn.items().iter().filter(|(item, _)| drawn.lit_in(item) > 0);
        if let Some((item, _)) = lit.next() {
            commands.trigger(ScrollTo { pane, item: Some(item.clone()), row: ItemRow::Lit(0) });
        }
    }
}

Implementations

impl DrawnTranscript

pub fn agent(&self) -> Option<Entity>

The agent whose transcript it is; None for a conversation no agent holds, or with no agent shown, when the pane draws the notices about every agent.

pub fn area(&self) -> Rect

Where its rows on screen are drawn: the first at the top; empty in one laid out without drawing it.

pub fn rows(&self) -> &[DrawnRow]

Its rows, top to bottom.

pub fn lines(&self) -> impl Iterator<Item = DrawnLine> + '_

Its lines as they were before the view wrapped them, top to bottom, each with its rows. Text a wrap split across two rows is whole here, for a search or a copy.

pub fn items(&self) -> &[(TranscriptItem, Range<usize>)]

Each item’s rows, top to bottom by first row. An item’s rows hold those of the items drawn inside it: a message’s, its calls and the notices and notes written inside it. Rows of no item, such as the reply streaming in, are in none.

pub fn rows_of(&self, item: &TranscriptItem) -> Option<Range<usize>>

The rows of item, or None when it is not drawn.

pub fn item_at(&self, row: usize) -> Option<&TranscriptItem>

The innermost item row belongs to, such as a call rather than its message, or a decorator’s rows rather than their call.

pub fn lit_in(&self, item: &TranscriptItem) -> usize

How many matches of every highlight the view lit in item’s rows: n in ItemRow::Lit counts these, so it finds a row for each n below this.

pub fn on_screen(&self) -> Range<usize>

The rows on screen; none in one laid out without drawing it.

pub fn item(&self, item: &TranscriptItem) -> Option<Self>

Only item’s rows, as a transcript of their own: its rows from 0, the items drawn in it, and its rows on screen. None when it is not drawn.

Trait Implementations

impl Clone for DrawnTranscript

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for DrawnTranscript

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 DrawnTranscript

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

Formats the value using the given formatter.

impl Default for DrawnTranscript

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DrawnTranscript

impl PartialEq for DrawnTranscript

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DrawnTranscript