Struct CompositionInput 

#[non_exhaustive]
pub struct CompositionInput<'a> {

    pub turn: &'a TurnInput,
    pub attachments: Vec<ContentPart>,
    pub answer_tasks: &'a [AnswerTask],
    pub events: &'a [EventBatch],
    pub ledger: &'a [LedgerReceiptGroup],
    pub interactions: &'a [Interaction],
    pub views: &'a [ErasedWorkflowView],
    pub subjects: &'a [CaseKey],
    pub touched: &'a [CaseKey],
    pub beside: &'a [CaseKey],
    pub reachable_only: &'a [CaseKey],
    pub recent: &'a [RecentMessage],
    pub preceding_reply: Option<&'a str>,
    pub artifacts_shown: &'a [BlockId],
    pub case_labels: &'a [CaseLabel],
    pub next_steps: &'a [(CaseKey, Vec<LocalizedText>)],
    pub named_workflows: &'a [WorkflowKey],
    pub unavailable: &'a [UnavailableWorkflow],
    pub disputes: &'a [String],
    pub started: &'a [WorkflowKey],
    pub contested: &'a [String],
    pub notices: &'a [ServerNotice],
    pub refusals: &'a [NarratableFact],
    pub outcomes: OutcomeFlags,
    pub effort: Option<&'a EffortProfile>,
}

Everything one composition reads.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

turn: &'a TurnInput

The turn being answered.

attachments: Vec<ContentPart>

The turn’s files, for the stage that answers.

answer_tasks: &'a [AnswerTask]

The questions the reducer produced, with their basis.

events: &'a [EventBatch]

Event batches that committed, in commit order.

ledger: &'a [LedgerReceiptGroup]

Ledger groups read back from the journal, used instead of Self::events when a response is regenerated: a stored event may have been redacted since.

interactions: &'a [Interaction]

Cards on screen after the turn.

views: &'a [ErasedWorkflowView]

The cases as they now stand.

subjects: &'a [CaseKey]

The cases the turn was about.

touched: &'a [CaseKey]

The cases an act of the turn reached, in act order: where the ask comes from.

beside: &'a [CaseKey]

Other cases in view the ask may move on to once the touched ones need nothing.

reachable_only: &'a [CaseKey]

Cases in view only because the actor may reach them.

recent: &'a [RecentMessage]

The earlier messages, oldest first.

preceding_reply: Option<&'a str>

The reply just before this turn.

artifacts_shown: &'a [BlockId]

Artifact blocks the conversation already carries.

case_labels: &'a [CaseLabel]

What each case is called.

next_steps: &'a [(CaseKey, Vec<LocalizedText>)]

What each case lets the user do next once it owes nothing, by case.

named_workflows: &'a [WorkflowKey]

Workflows the turn named.

unavailable: &'a [UnavailableWorkflow]

Workflows that cannot start, with their reasons.

disputes: &'a [String]

What the user said the assistant got wrong.

started: &'a [WorkflowKey]

Workflows the turn started without writing anything yet.

contested: &'a [String]

Receipts of the last reply the user contested, as they were shown.

notices: &'a [ServerNotice]

Notices the turn already carries.

refusals: &'a [NarratableFact]

What the reduction and the execution decided, as facts.

outcomes: OutcomeFlags

Deterministic outcome flags.

effort: Option<&'a EffortProfile>

The effort the turn runs at: its reply budget and task profiles.

Implementations

impl<'a> CompositionInput<'a>

pub fn new(turn: &'a TurnInput) -> Self

An input with nothing but the turn.

impl<'a> CompositionInput<'a>

pub fn with_attachments(self, value: Vec<ContentPart>) -> Self

Sets the turn’s files.

pub fn with_answer_tasks(self, value: &'a [AnswerTask]) -> Self

Sets the questions.

pub fn with_events(self, value: &'a [EventBatch]) -> Self

Sets the committed events.

pub fn with_ledger(self, value: &'a [LedgerReceiptGroup]) -> Self

Sets the ledger groups of a regenerated response.

pub fn with_interactions(self, value: &'a [Interaction]) -> Self

Sets the cards on screen.

pub fn with_views(self, value: &'a [ErasedWorkflowView]) -> Self

Sets the views.

pub fn with_subjects(self, value: &'a [CaseKey]) -> Self

Sets the subjects.

pub fn with_touched(self, value: &'a [CaseKey]) -> Self

Sets the cases an act reached.

pub fn with_beside(self, value: &'a [CaseKey]) -> Self

Sets the cases the ask may move on to.

pub fn with_reachable_only(self, value: &'a [CaseKey]) -> Self

Sets the cases in view only because they are reachable.

pub fn with_recent(self, value: &'a [RecentMessage]) -> Self

Sets the earlier messages.

pub fn with_preceding_reply(self, value: Option<&'a str>) -> Self

Sets the reply just before this turn.

pub fn with_artifacts_shown(self, value: &'a [BlockId]) -> Self

Sets the artifact blocks already shown.

pub fn with_case_labels(self, value: &'a [CaseLabel]) -> Self

Sets the case labels.

pub fn with_next_steps(self, value: &'a [(CaseKey, Vec<LocalizedText>)]) -> Self

Sets what each case lets the user do next.

pub fn with_named_workflows(self, value: &'a [WorkflowKey]) -> Self

Sets the workflows the turn named.

pub fn with_unavailable(self, value: &'a [UnavailableWorkflow]) -> Self

Sets the workflows that cannot start.

pub fn with_disputes(self, value: &'a [String]) -> Self

Sets what the user disputed.

pub fn with_started(self, value: &'a [WorkflowKey]) -> Self

Sets the workflows started without a write.

pub fn with_contested(self, value: &'a [String]) -> Self

Sets the receipts the user contested.

pub fn with_notices(self, value: &'a [ServerNotice]) -> Self

Sets the notices.

pub fn with_refusals(self, value: &'a [NarratableFact]) -> Self

Sets the facts of what was decided.

pub fn with_outcomes(self, value: OutcomeFlags) -> Self

Sets the outcome flags.

pub fn with_effort(self, value: Option<&'a EffortProfile>) -> Self

Sets the effort the turn runs at.

Trait Implementations

impl<'a> Clone for CompositionInput<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CompositionInput<'a>

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

Formats the value using the given formatter.