Struct Completion 

pub struct Completion;

Generating an assistant turn, unary or streamed.

Trait Implementations

impl Clone for Completion

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Completion

impl Debug for Completion

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

Formats the value using the given formatter.

impl<'id> Decoder<'id, Completion, MockFrame> for MockDecoder<'id>

Available on crate feature test-utils only.

type Event = MockFrame

The wire’s typed event, produced by this decoder’s classifier.

fn classify(&self, frame: MockFrame) -> WireEvent<MockFrame>

Decode and classify one frame. A JSON wire MUST delegate to a classifier in crate::providers::internal::wire, so the decode-then-validate policy is not re-derived per provider.

fn decode( &mut self, frame: MockFrame, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

fn eof(&mut self, out: Out<'id, Op>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl<'id> Decoder<'id, Completion> for MessagesDecoder

type Event = MessagesEvent

The wire’s typed event, produced by this decoder’s classifier.

fn classify(&self, frame: WireFrame) -> WireEvent<MessagesEvent>

Decode and classify one frame. A JSON wire MUST delegate to a classifier in crate::providers::internal::wire, so the decode-then-validate policy is not re-derived per provider.

fn decode( &mut self, event: MessagesEvent, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

fn eof(&mut self, out: Out<'id, Op>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl<'id> Decoder<'id, Completion> for ChatDecoder

fn classify(&self, frame: WireFrame) -> WireEvent<ChatEvent>

A stream event by its type; a frame without one is the whole reply, recognized by its message.

type Event = ChatEvent

The wire’s typed event, produced by this decoder’s classifier.

fn decode( &mut self, event: ChatEvent, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

fn eof(&mut self, out: Out<'id, Op>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl<'id> Decoder<'id, Completion> for CohereDecoder

type Event = CohereEvent

The wire’s typed event, produced by this decoder’s classifier.

fn classify(&self, frame: WireFrame) -> WireEvent<CohereEvent>

Decode and classify one frame. A JSON wire MUST delegate to a classifier in crate::providers::internal::wire, so the decode-then-validate policy is not re-derived per provider.

fn decode( &mut self, event: CohereEvent, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

fn eof(&mut self, out: Out<'id, Completion>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl<'id> Decoder<'id, Completion> for InteractionsDecoder

EOF without interaction.completed is truncation, not successful completion, so the decoder has nothing to add at the end of the reply.

fn classify(&self, frame: WireFrame) -> WireEvent<InteractionsEvent>

Classify a frame by its event_type tag, or as a whole resource by its marker keys when it carries no tag. A tagged frame never passes for a whole resource.

type Event = InteractionsEvent

The wire’s typed event, produced by this decoder’s classifier.

fn decode( &mut self, event: InteractionsEvent, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

fn eof(&mut self, out: Out<'id, Op>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl<'id> Decoder<'id, Completion> for GenerateContentDecoder

fn eof(&mut self, out: Out<'id, Completion>) -> Result<Flow, ProviderError>

Gemini ends a reply at EOF, not at its first finish reason: a hosted-tool round can report one before more content arrives.

type Event = GenerateContentChunk

The wire’s typed event, produced by this decoder’s classifier.

fn classify(&self, frame: WireFrame) -> WireEvent<GenerateContentChunk>

Decode and classify one frame. A JSON wire MUST delegate to a classifier in crate::providers::internal::wire, so the decode-then-validate policy is not re-derived per provider.

fn decode( &mut self, GenerateContentChunk: GenerateContentChunk, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

impl<'id> Decoder<'id, Completion> for ChatDecoder

fn decode( &mut self, ChatRecord: ChatRecord, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Fields are read leniently: one the record leaves out or sends with another type is absent, so only error and done steer the reply.

type Event = ChatRecord

The wire’s typed event, produced by this decoder’s classifier.

fn classify(&self, frame: WireFrame) -> WireEvent<ChatRecord>

Decode and classify one frame. A JSON wire MUST delegate to a classifier in crate::providers::internal::wire, so the decode-then-validate policy is not re-derived per provider.

fn eof(&mut self, out: Out<'id, Op>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl<'id> Decoder<'id, Completion> for ResponsesDecoder

type Event = ResponsesEvent

The wire’s typed event, produced by this decoder’s classifier.

fn classify(&self, frame: WireFrame) -> WireEvent<ResponsesEvent>

Decode and classify one frame. A JSON wire MUST delegate to a classifier in crate::providers::internal::wire, so the decode-then-validate policy is not re-derived per provider.

fn decode( &mut self, event: ResponsesEvent, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

fn eof(&mut self, out: Out<'id, Op>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl<'id> Decoder<'id, Completion> for OpenAiDecoder

type Event = OpenAiEvent

The wire’s typed event, produced by this decoder’s classifier.

fn classify(&self, frame: WireFrame) -> WireEvent<OpenAiEvent>

Decode and classify one frame. A JSON wire MUST delegate to a classifier in crate::providers::internal::wire, so the decode-then-validate policy is not re-derived per provider.

fn decode( &mut self, event: OpenAiEvent, out: Out<'id, Completion>, ) -> Result<Flow, ProviderError>

Write one Known event into the reply. An error ends the reply with it.

fn eof(&mut self, out: Out<'id, Completion>) -> Result<Flow, ProviderError>

The frames ran out without an end. A decoder that already saw the provider’s end, in a form the provider sends before its last frame, ends the reply here; otherwise the reply is truncated.

impl Emit<Completion> for Assembled

impl Eq for Completion

impl Fold<Completion> for Turn

fn absorb(&mut self, event: &StreamEvent) -> Result<(), ProviderError>

Absorb one event the consumer is about to see. An error fails the reply.

fn finish( self, end: Finish, reply: Reply, ) -> Result<CompletionResponse, ProviderError>

The response, from the events absorbed, the provider’s end and what the driver learned about the reply.

impl Operation for Completion

fn fold(request: &Self::Request, call: &mut Call<'_>) -> Self::Fold

The call’s span names the model the request overrides to, when it names one: every wire honours the override on encode.

fn prepare( request: Self::Request, wire: &Descriptor<'_>, ) -> Result<Self::Request, ProviderError>

Resolve the model the request addresses once, as the request’s model: the one it names, else the wire’s. The history is checked with CompletionRequest::validate_message_content, then adapted for that model on the wire’s replay target and checked again. Encoders, the fold and replay all read the one resolved model. Each option the routed target refuses is reported first, through options::check.

type Request = CompletionRequest

The normalized request this operation accepts.

type Event = StreamEvent

One decoded step of a reply.

type End = Finish

What the provider sends when it ends the reply. A fold needs one to produce a response, so a reply that stopped early has none.

type Response = CompletionResponse

The normalized response the events and the end fold into.

type Fold = Turn

One reply’s state: it absorbs the events the consumer sees, then folds them with the end into the response.

type Emit = Assembled

Who builds the events: Free for events a decoder writes itself, Assembled for the completion events only the writer’s part handles build.

impl PartialEq for Completion

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

Equality operator ==.

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

Inequality operator !=.

impl Serves<Completion> for Interaction

impl Serves<Completion> for GenerateContentResponse

impl Serves<Completion> for OpenAiReassembler

impl Serves<Completion> for MockDocument

Available on crate feature test-utils only.

impl StructuralPartialEq for Completion