Struct ModelCompletion 

pub struct ModelCompletion { /* private fields */ }

Successful terminal model completion data.

Implementations

impl ModelCompletion

pub fn completed() -> Self

Creates a normal successful completion.

pub fn new(stop_reason: StopReason) -> Result<Self, ModelStreamValueError>

Creates successful terminal completion data.

Errors

Returns an error for cancelled, error, or unknown stop reasons. Those outcomes must use ModelEvent::Failed.

pub fn with_usage(self, usage: Usage) -> Self

Adds normalized token usage.

pub fn with_cost(self, cost: ExactCost) -> Self

Adds exact provider-reported cost.

pub fn with_metadata(self, metadata: ProtocolMetadata) -> Self

Adds bounded terminal metadata.

pub const fn stop_reason(&self) -> &StopReason

Returns the normalized stop reason.

pub const fn usage(&self) -> Option<&Usage>

Returns normalized token usage when reported.

pub const fn cost(&self) -> Option<&ExactCost>

Returns exact provider-reported cost when available.

pub const fn metadata(&self) -> &ProtocolMetadata

Returns bounded terminal metadata.

Trait Implementations

impl Clone for ModelCompletion

fn clone(&self) -> ModelCompletion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelCompletion

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

Formats the value using the given formatter.

impl PartialEq for ModelCompletion

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModelCompletion