Struct PendingCompletion 

pub struct PendingCompletion {
    pub deadline: Option<Duration>,
    pub on_timeout: TimeoutBehavior,
    pub on_cancel: CancelHint,
}

Configuration carried by a ToolResult::Pending result: how long the runtime waits for the deferred outcome, and what to do if it times out or is cancelled.

Defaults to no deadline, TimeoutBehavior::ErrorAsResult, and CancelHint::CancelExternalWork. Build one with PendingCompletion::new and the with_* adjusters.

Fields

deadline: Option<Duration>

Maximum time to wait for the deferred outcome. None waits indefinitely (until the turn or process is otherwise cancelled).

on_timeout: TimeoutBehavior

What the runtime does when deadline elapses without a resolution.

on_cancel: CancelHint

What the runtime signals about out-of-band work if the call is cancelled.

Implementations

impl PendingCompletion

pub fn new() -> Self

pub fn with_deadline(self, deadline: Duration) -> Self

pub fn fail_turn_on_timeout(self) -> Self

Trait Implementations

impl Clone for PendingCompletion

fn clone(&self) -> PendingCompletion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PendingCompletion

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

Formats the value using the given formatter.

impl Default for PendingCompletion

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PendingCompletion

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PendingCompletion

fn eq(&self, other: &PendingCompletion) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PendingCompletion

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PendingCompletion