Codex.RunResultStreaming (Codex SDK v0.6.0)

Streaming result wrapper exposing semantic and raw event streams plus cancellation controls.

Summary

t()

Cancels the streaming run.

events(result)

Returns a stream of semantic events. Automatically starts the underlying streaming process on first invocation.

Pops the next semantic event from the queue, blocking up to timeout.

Returns a stream of the raw Codex events.

Returns the aggregated usage captured so far.

@type t() :: %Codex.RunResultStreaming{
  control: pid(),
  queue: pid(),
  start_fun: (-> any())
}

@spec cancel(t(), :immediate | :after_turn) :: :ok

Cancels the streaming run.

Modes:

@spec events(t()) :: Enumerable.t()

Returns a stream of semantic events. Automatically starts the underlying streaming process on first invocation.

@spec pop(t(), timeout()) :: {:ok, term()} | {:error, term()} | :done

Pops the next semantic event from the queue, blocking up to timeout.

Returns {:error, reason} if the stream terminates with an error.

@spec raw_events(t()) :: Enumerable.t()

Returns a stream of the raw Codex events.

@spec usage(t()) :: map()

Returns the aggregated usage captured so far.