Struct EventStream 

pub struct EventStream { /* private fields */ }

A decoded, self-reconnecting subscription to an opencode event stream.

Construct one with EventStream::connect (or EventStream::from_request when you need custom headers, query parameters, or authentication) and pull items with EventStream::next or via its Stream implementation.

Implementations

impl EventStream

pub fn connect(base_url: &str) -> Result<Self>

Subscribe to GET {base_url}/event with the default RetryConfig, against a no-auth server.

No credentials are attached and the environment is never consulted. For an authenticated server, prefer OpencodeClient::event_stream, which reuses the client’s configured auth, or build the request yourself and use EventStream::from_request.

This prepares the request but performs no network I/O, so it returns Ok even if the server is down. With the default RetryConfig (max_retries = None) an unreachable server is retried forever and never surfaces an Err; see the module docs for how to avoid a silent hang.

Errors

Returns Error if the request cannot be prepared for streaming.

pub fn connect_with( client: &Client, base_url: &str, retry: RetryConfig, ) -> Result<Self>

Subscribe to GET {base_url}/event on a caller-supplied Client with an explicit RetryConfig, reusing the client’s connection pool.

Like EventStream::connect, this attaches no auth and never reads the environment. Consistent with the REST transport, OPENCODE_SERVER_PASSWORD is only consulted through an explicit opt-in (BasicAuth::from_env / OpencodeClientBuilder::auth_from_env), not on this connect path.

Errors

Returns Error if the request cannot be prepared for streaming.

pub fn from_request(builder: RequestBuilder, retry: RetryConfig) -> Result<Self>

Wrap a fully-prepared RequestBuilder (with whatever headers, query parameters, or auth you need) as a decoded event stream.

The request should target an SSE endpoint — EVENT_PATH or GLOBAL_EVENT_PATH. The Accept: text/event-stream header is added for you.

Errors

Returns Error if the request cannot be cloned for reconnects (only possible for requests carrying a non-replayable streaming body, which the GET event endpoints never do).

pub async fn next(&mut self) -> Option<Result<StreamEvent>>

Await the next decoded item, or None once the stream has closed.

This is the Stream contract as an inherent async method so callers need no StreamExt import.

pub fn ready_state(&self) -> ReadyState

The current connection state of the underlying event source.

pub fn close(&mut self)

Stop the stream and its reconnection attempts. The next poll yields None. Dropping the EventStream does the same.

Trait Implementations

impl Stream for EventStream

type Item = Result<StreamEvent, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.