Struct OpenStreamWriter 

pub struct OpenStreamWriter { /* private fields */ }

Minimal CEP-41 producer/writer.

Implementations

impl OpenStreamWriter

pub fn new(options: OpenStreamWriterOptions) -> Self

Create a new writer from explicit options.

pub fn progress_token(&self) -> &str

The stream id (stringified progressToken).

pub fn is_active(&self) -> bool

Whether the writer is still live (not yet closed/aborted).

true for any freshly-created writer; see has_started.

pub fn has_started(&self) -> bool

Whether the writer has begun streaming by publishing its start frame.

Distinct from is_active: used to tell apart writers a tool actually streams through from ones created only because the request carried a progress token (the response-deferral guard).

pub async fn start(&self) -> Result<()>

Explicitly publish the start frame (idempotent; lazy on first write).

pub async fn write(&self, data: String) -> Result<()>

Publish one ordered chunk frame, starting the stream lazily.

pub async fn ping(&self) -> Result<()>

Publish a keepalive ping carrying a fresh {token}:{n} nonce.

pub async fn pong(&self, nonce: String) -> Result<()>

Publish a pong echoing the peer’s ping nonce.

pub async fn close(&self) -> Result<()>

Close the stream gracefully. Declares lastChunkIndex iff any chunks were written. Runs on_close after the frame is published (even on publish failure); propagates the publish error.

pub async fn abort(&self, reason: Option<String>) -> Result<()>

Abort the stream (terminal). Claims the terminal transition without the op lock, so it never waits on a stuck write. Runs on_abort after the frame is published (even on publish failure); propagates the publish error. Idempotent: a second abort (or one after close) is a no-op.

Trait Implementations

impl Clone for OpenStreamWriter

fn clone(&self) -> OpenStreamWriter

Returns a duplicate of the value.

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

Performs copy-assignment from source.