Struct ModelEventStream 

pub struct ModelEventStream { /* private fields */ }

Receiver for incremental model JSON events.

Implementations

impl ModelEventStream

pub fn new(receiver: Receiver<Result<Value, ModelError>>) -> Self

Build a stream from a channel receiver.

pub const fn new_with_cancellation( receiver: Receiver<Result<Value, ModelError>>, cancellation_token: CancellationToken, ) -> Self

Build a stream from a channel receiver and cancellation token.

pub const fn new_with_cancellation_and_drop_abort( receiver: Receiver<Result<Value, ModelError>>, cancellation_token: CancellationToken, drop_abort_token: Option<CancellationToken>, ) -> Self

Build a stream from a channel receiver, cancellation token, and drop-abort token.

pub fn drop_abort_token(&self) -> Option<CancellationToken>

Return the transport-local drop-abort token, when the stream owns one.

pub async fn recv(&mut self) -> Option<Result<Value, ModelError>>

Receive the next JSON event from the stream.

Trait Implementations

impl Drop for ModelEventStream

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.