Skip to main content

CompletionPlan

Struct CompletionPlan 

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

A validated run-to-completion call, separable from the start request it was planned for.

Separate so a binding can start the exec under its sandbox lock and drive it after releasing the lock: a callback that reaches back into the sandbox must not find the lock held by the call that is invoking it.

Implementations§

Source§

impl CompletionPlan

Source

pub fn new( request: &StartRequest, options: CompletionOptions, ) -> Result<CompletionPlan, Error>

Plans a call for request, refusing a timeout_sec no deadline can be built from before anything starts.

Source

pub fn deadline(&self) -> Duration

The client deadline, measured from the start of Self::drive.

Source

pub async fn drive( &self, handle: &ExecHandle, on_output: Option<Box<dyn FnMut(ExecEvent) -> Pin<Box<dyn Future<Output = ControlFlow<()>> + Send>> + Send>>, ) -> Result<ExecResult, Error>

Drives a started exec to exactly one result.

The steps, each the specified behavior in crates/model/src/run.rs:

  1. With a callback, stream to it under the client deadline. The terminal exit event means the output is final, so one ack returns it (BIND-8).
  2. Without a callback, or when the stream ended without its exit event (a cut past its reconnect budget, a fatal stream error, the callback answering Break), or when the ack after the exit event failed: wait and ack under what is left of the deadline (BIND-8). Polling is read-only, so this is safe whatever the stream saw.
  3. When the client deadline expires in either step: kill the process group, then wait and ack within the client grace (BIND-9). The kill is sent whatever its outcome turns out to be, and a failed kill still gets the ack: the command may have finished by itself, and its real result beats a synthesized one. The daemon answers the kill only once the group is gone, SIGKILLing it after its ten-second kill_grace if it must (measured 2026-09-24, us-east-1), so the kill can take that long before the grace starts.
  4. When that ack fails too: a synthesized result, exit code 124, naming both failures (BIND-10). Nothing else synthesizes.

An error is returned only for a failure that says nothing about a deadline: a fatal wait (the exec was collected, the token was refused). A retryable poll failure is retried inside the wait, as ExecHandle::wait always has.

Trait Implementations§

Source§

impl Clone for CompletionPlan

Source§

fn clone(&self) -> CompletionPlan

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
Source§

impl Debug for CompletionPlan

Source§

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

Formats the value using the given formatter. 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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more