pub struct CancelOperation<'a, Admission = Waiting, Termination = TerminationUnbounded, Target = TaskTarget> { /* private fields */ }Expand description
A task-cancellation operation with independent queue and termination-wait policy.
fail_fast changes only command-queue admission.
termination_timeout changes only the later wait for logical terminal cleanup.
The two settings can be applied in either order.
Implementations§
Source§impl<'a, Termination, Target> CancelOperation<'a, Waiting, Termination, Target>
impl<'a, Termination, Target> CancelOperation<'a, Waiting, Termination, Target>
Sourcepub fn fail_fast(self) -> CancelOperation<'a, FailFast, Termination, Target>
pub fn fail_fast(self) -> CancelOperation<'a, FailFast, Termination, Target>
Immediate admission to the required management queue.
Source§impl<'a, Admission, Target> CancelOperation<'a, Admission, TerminationUnbounded, Target>
impl<'a, Admission, Target> CancelOperation<'a, Admission, TerminationUnbounded, Target>
Sourcepub fn termination_timeout(
self,
wait_for: Duration,
) -> CancelOperation<'a, Admission, TerminationTimed, Target>
pub fn termination_timeout( self, wait_for: Duration, ) -> CancelOperation<'a, Admission, TerminationTimed, Target>
Deadline for this caller’s logical terminal-cleanup wait.
Queue admission and the cancellation claim are outside this deadline. A timeout does not undo an already committed cancellation.
Source§impl<Target> CancelOperation<'_, Waiting, TerminationUnbounded, Target>where
Target: Into<TaskTarget>,
impl<Target> CancelOperation<'_, Waiting, TerminationUnbounded, Target>where
Target: Into<TaskTarget>,
Sourcepub async fn execute(self) -> Result<bool, RuntimeError>
pub async fn execute(self) -> Result<bool, RuntimeError>
Cancellation claim after waiting queue admission and logical terminal cleanup.
§Errors
- Returns
RuntimeError::ShuttingDownwhen runtime intake is closed; RuntimeError::ResourceLimitReachedwhen the controller identity-operation budget is exhausted.
Source§impl<Target> CancelOperation<'_, FailFast, TerminationUnbounded, Target>where
Target: Into<TaskTarget>,
impl<Target> CancelOperation<'_, FailFast, TerminationUnbounded, Target>where
Target: Into<TaskTarget>,
Sourcepub async fn execute(self) -> Result<bool, RuntimeError>
pub async fn execute(self) -> Result<bool, RuntimeError>
Cancellation claim after immediate queue admission and unbounded terminal cleanup.
§Errors
- Returns
RuntimeError::ShuttingDownwhen runtime intake is closed; RuntimeError::CommandQueueFullwhen the required management queue has no capacity;RuntimeError::ResourceLimitReachedwhen the controller identity-operation budget is exhausted.
Source§impl<Target> CancelOperation<'_, Waiting, TerminationTimed, Target>where
Target: Into<TaskTarget>,
impl<Target> CancelOperation<'_, Waiting, TerminationTimed, Target>where
Target: Into<TaskTarget>,
Sourcepub async fn execute(self) -> Result<bool, RuntimeError>
pub async fn execute(self) -> Result<bool, RuntimeError>
Cancellation claim after waiting queue admission and bounded terminal cleanup.
§Errors
- Returns
RuntimeError::ShuttingDownwhen runtime intake is closed; RuntimeError::TaskTerminationTimeoutwhen registered task cleanup exceeds this caller’s deadline;RuntimeError::ResourceLimitReachedwhen the controller identity-operation budget is exhausted.
Source§impl<Target> CancelOperation<'_, FailFast, TerminationTimed, Target>where
Target: Into<TaskTarget>,
impl<Target> CancelOperation<'_, FailFast, TerminationTimed, Target>where
Target: Into<TaskTarget>,
Sourcepub async fn execute(self) -> Result<bool, RuntimeError>
pub async fn execute(self) -> Result<bool, RuntimeError>
Cancellation claim after immediate queue admission and bounded terminal cleanup.
§Errors
- Returns
RuntimeError::ShuttingDownwhen runtime intake is closed; RuntimeError::CommandQueueFullwhen the required management queue has no capacity;RuntimeError::TaskTerminationTimeoutwhen registered task cleanup exceeds this caller’s deadline;RuntimeError::ResourceLimitReachedwhen the controller identity-operation budget is exhausted.