Struct CancelHandle 

pub struct CancelHandle { /* private fields */ }

Handle to cancel an in-flight streaming request.

Call cancel to signal the stream to stop. The stream will emit a final StreamEnd { finish_reason: Some("cancelled") } and then terminate.

Example

let (stream, cancel_handle) = client.chat()
    .messages(msgs)
    .stream()
    .execute_stream_with_cancel()
    .await?;

// Cancel from another task or on user action
tokio::spawn(async move {
    tokio::time::sleep(Duration::from_secs(5)).await;
    cancel_handle.cancel();
});

Implementations

impl CancelHandle

pub fn cancel(self)