Skip to main content

TurnPublisher

Struct TurnPublisher 

Source
pub struct TurnPublisher { /* private fields */ }
Expand description

Publishes a turn’s events through a sink, under the PublicationGate.

The gate is the reason this type exists rather than a bare sink: the orchestrator advances the phase as it goes, and a block offered too early is dropped instead of published, whatever the caller intended.

Implementations§

Source§

impl TurnPublisher

Source

pub fn new(sink: Arc<dyn TurnSink>) -> Self

A publisher writing to sink.

Source

pub fn null() -> Self

A publisher that drops everything.

Source

pub const fn is_live(&self) -> bool

Whether anything is listening: false for Self::null.

compose asks before it goes looking for a streaming-capable provider, because a turn nobody is watching has no reason to prefer one.

Source

pub fn phase(&self) -> TurnPhase

The phase the gate is at.

Source

pub fn phase_reached(&self, phase: TurnPhase)

Announces a phase and moves the gate to it.

Source

pub fn publish_step(&self, step: Step)

Publishes one step of the understanding. Steps are not outcomes, so the gate never holds them back.

Source

pub fn step_said(&self, step: Step, text: String)

Publishes a step as a model said it.

Source

pub fn block(&self, block: &ResponseBlock) -> bool

Publishes one block if the gate admits it, and returns whether it went out.

Source

pub fn blocks(&self, turn: &AssistantTurn)

Publishes every block of a composed turn, in order.

Source

pub fn completed(&self, turn: &AssistantTurn)

Ends the stream with the turn that was persisted.

Source

pub fn failed(&self, code: impl Into<String>)

Ends the stream with a stable failure code.

Trait Implementations§

Source§

impl Debug for TurnPublisher

Source§

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

Formats the value using the given formatter. Read more
Source§

impl StepSink for TurnPublisher

Source§

fn step(&self, step: Step)

Delivers one step. Implementations must not block.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more