Struct Submit 

pub struct Submit<'a, Watch = Unwatched, Admission = Waiting> { /* private fields */ }

Available on crate feature controller only.

An explicit single-use controller submission operation.

Configure final-outcome delivery and an optional ownership-admission deadline. Finish with execute or try_intake. The default waiting, unwatched operation can also be awaited directly. APIs that accept a Future require execute() or IntoFuture::into_future. Every terminal method consumes the operation, including when intake returns an error.

Watch and Admission are operation type states. watch and ownership_timeout select them. Applications do not need to name them.

Implementations

impl<'a, Admission> Submit<'a, Unwatched, Admission>

pub fn watch(self) -> Submit<'a, Watched, Admission>

Final-outcome delivery through TaskWaiter.

Successful intake returns only TaskWaiter. Its TaskWaiter::id is the submission identity. The waiter later reports controller rejection or the admitted task’s final outcome.

impl<'a, Watch> Submit<'a, Watch, Waiting>

pub fn ownership_timeout( self, wait_for: Duration, ) -> Submit<'a, Watch, OwnershipTimed>

Cleanup-ownership admission deadline.

The deadline stops after ownership succeeds. execute can then wait without a deadline for controller command capacity. An immediately available permit can succeed when wait_for is Duration::ZERO. A timeout sends no command and publishes no lifecycle event.

impl Submit<'_, Unwatched, Waiting>

pub async fn execute(self) -> Result<TaskId, ControllerError>

Waiting controller command intake with an unwatched TaskId result.

Ok(id) confirms only command intake. Slot admission and runtime registration happen later. Awaiting the default operation directly is equivalent to calling this method. A successful PreparedSubmission cannot produce NotConfigured.

Errors

• Returns ControllerError::NotConfigured when a direct submission has no controller;
• ControllerError::ThreadStartFailed when cleanup workers cannot start;
• ControllerError::ResourceLimit when cleanup ownership is unavailable;
• ControllerError::Closed when controller intake is closed.

pub fn try_intake(self) -> Result<TaskId, ControllerError>

Fail-fast controller command intake with an unwatched TaskId result.

Ok(id) has the same intake-only meaning as execute. A successful PreparedSubmission cannot produce NotConfigured.

Errors

• Returns ControllerError::NotConfigured when a direct submission has no controller;
• ControllerError::ThreadStartFailed when cleanup workers cannot start;
• ControllerError::ResourceLimit when cleanup ownership is unavailable;
• ControllerError::Full when controller command capacity is unavailable;
• ControllerError::Closed when controller intake is closed.

impl Submit<'_, Unwatched, OwnershipTimed>

pub async fn execute(self) -> Result<TaskId, ControllerError>

Ownership-bounded admission followed by normal command-queue backpressure.

A successful PreparedSubmission cannot produce NotConfigured.

Errors

• Returns ControllerError::NotConfigured when a direct submission has no controller;
• ControllerError::ThreadStartFailed when cleanup workers cannot start;
• ControllerError::ResourceLimit when cleanup ownership cannot be granted;
• ControllerError::OwnershipAdmissionTimeout when cleanup ownership remains unavailable at the configured deadline;
• ControllerError::Closed when controller intake is closed.

impl Submit<'_, Watched, Waiting>

pub async fn execute(self) -> Result<TaskWaiter, ControllerError>

Waiting controller command intake with a final-outcome waiter.

Success confirms only controller command intake. TaskWaiter::id is the submission identity. TaskWaiter::wait reports rejection or the admitted task’s final outcome. A successful PreparedSubmission cannot produce NotConfigured.

Errors

• Returns ControllerError::NotConfigured when a direct submission has no controller;
• ControllerError::ThreadStartFailed when cleanup workers cannot start;
• ControllerError::ResourceLimit when cleanup ownership is unavailable;
• ControllerError::Closed when controller intake is closed.

pub fn try_intake(self) -> Result<TaskWaiter, ControllerError>

Fail-fast controller command intake with a final-outcome waiter.

A successful PreparedSubmission cannot produce NotConfigured.

Errors

• Returns ControllerError::NotConfigured when a direct submission has no controller;
• ControllerError::ThreadStartFailed when cleanup workers cannot start;
• ControllerError::ResourceLimit when cleanup ownership is unavailable;
• ControllerError::Full when controller command capacity is unavailable;
• ControllerError::Closed when controller intake is closed.

impl Submit<'_, Watched, OwnershipTimed>

pub async fn execute(self) -> Result<TaskWaiter, ControllerError>

Ownership-bounded admission with a final-outcome waiter after command intake.

A successful PreparedSubmission cannot produce NotConfigured.

Errors

• Returns ControllerError::NotConfigured when a direct submission has no controller;
• ControllerError::ThreadStartFailed when cleanup workers cannot start;
• ControllerError::ResourceLimit when cleanup ownership cannot be granted;
• ControllerError::OwnershipAdmissionTimeout when cleanup ownership remains unavailable at the configured deadline;
• ControllerError::Closed when controller intake is closed.

Trait Implementations

impl<Watch, Admission> Debug for Submit<'_, Watch, Admission>

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

Formats the value using the given formatter.

impl<'a> IntoFuture for Submit<'a, Unwatched, Waiting>

type Output = Result<TaskId, ControllerError>

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = <Submit<'a> as IntoFuture>::Output> + Send + 'a>>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.