Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Cancellation token for streaming requests

Implementations

impl CancellationToken

pub fn new() -> Self

Create a new cancellation token

pub fn cancel(&self)

Cancel the streaming request

pub fn pause(&self)

Pause the streaming request with the intent to resume later.

pub fn is_cancelled(&self) -> bool

Check if cancellation has been requested

pub fn is_pause_requested(&self) -> bool

Returns true when the request should be treated as resumably paused.

pub fn disposition(&self) -> CancellationDisposition

Returns the requested interruption disposition.

pub fn interruption_chunk(&self) -> StreamChunk

Terminal streaming chunk matching the currently requested interruption.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> Self

Returns the “default value” for a type.