Struct TurnControl

Source

pub struct TurnControl { /* private fields */ }

Expand description

Cheap cloneable control capability for one accepted turn.

Implementations§

Source §

impl TurnControl

Source

pub async fn steer(&self, prompt: impl Into<Prompt>) -> Result<()>

Injects additional input into the targeted turn.

§Errors

Returns an error for an empty prompt, when the turn is not active, when its steering queue is full, or if the driver stops.

Source

pub async fn steer_with_id( &self, id: String, prompt: impl Into<Prompt>, ) -> Result<()>

Admits input with a caller-owned identity unique within this turn.

§Errors

Returns admission errors or an error if identified steering is unsupported.

Source

pub async fn withdraw_steer(&self, id: String) -> Result<bool>

Withdraws the latest accepted steer before its model boundary. Returns false if the identity is no longer latest or was already consumed.

§Errors

Returns an error if persistence fails, the driver stops, or withdrawal is unsupported.

Source

pub async fn cancel(&self) -> Result<()>

Cancels the targeted unfinished turn.

§Errors

Returns an error when the turn has already finished or if the driver stops.

Trait Implementations§

Source §

impl Clone for TurnControl

Source §

fn clone(&self) -> TurnControl

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl UnsafeUnpin for TurnControl

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source §

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Downcast for T
where T: Any,

Source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

Source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

Source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

Source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

Source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

Source §