Skip to main content

CancellationController

Struct CancellationController 

Source
pub struct CancellationController { /* private fields */ }
Expand description

Owner-side handle for broadcasting cancellation to running turns.

Create one CancellationController per agent and hand out CancellationHandles to the loop and tool executors. Calling interrupt bumps an internal generation counter so that every outstanding TurnCancellation checkpoint becomes cancelled.

§Example

use agentkit_core::CancellationController;

let controller = CancellationController::new();
let handle = controller.handle();

// Before an interrupt the generation is 0.
assert_eq!(handle.generation(), 0);

// Signal cancellation (e.g. from a Ctrl-C handler).
controller.interrupt();
assert_eq!(handle.generation(), 1);

Implementations§

Source§

impl CancellationController

Source

pub fn new() -> Self

Creates a new controller with generation starting at 0.

Source

pub fn handle(&self) -> CancellationHandle

Returns a cloneable CancellationHandle that shares state with this controller.

Source

pub fn interrupt(&self) -> u64

Broadcasts a cancellation by incrementing the generation counter.

Returns the new generation value. All TurnCancellation checkpoints created before this call will report themselves as cancelled.

Trait Implementations§

Source§

impl Clone for CancellationController

Source§

fn clone(&self) -> CancellationController

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for CancellationController

Source§

fn default() -> CancellationController

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.