Skip to main content

RunHandle

Struct RunHandle 

Source
pub struct RunHandle<O> { /* private fields */ }
Expand description

A started run of a single task, and its output type.

Holding one does not hold a subscription open: the stream is opened when result is awaited, and closed again once nothing is waiting for anything.

It does keep a clone of the Client it was started from, which is what lets it wait (result) and cancel (cancel) on its own. A Client is one Arc, so that costs a reference — and it means a handle stays usable after the client it came from goes out of scope. There is no reference cycle: the client’s result listener never holds a Client (see client.rs).

Implementations§

Source§

impl<O> RunHandle<O>

Source

pub fn id(&self) -> &str

The engine’s id for this run. Runs are addressed by it in the dashboard and in the REST API.

Source

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

Stops this run.

One CancelTasks call naming this run. Measured on both supported engine versions: a workflow run id cancels every task of that run that exists when the call arrives — a task the engine has not created yet is not covered and will still run, so a run that fans out over time may need cancelling more than once.

Cancelling a run that is already over is not an error, and neither is cancelling one the engine has never heard of: the engine answers both by echoing the id back. There is therefore nothing to check — the answer is not proof of effect — and this hands back nothing.

The run’s own handler sees the cancellation as Context::cancelled; a waiter on result sees Error::RunCancelled.

let run = task.run_no_wait(client, &(), RunOpts::default()).await?;
run.cancel().await?;
§Errors

Error::Grpc when the call fails.

Source

pub async fn stream(&self) -> Result<OutputStream>

The output stream of this run: the chunks its handler publishes with Context::put_stream.

Exactly RunsClient::stream for this run’s id, which documents what a subscription opened after the trigger can miss, what ends the stream, and the five seconds this can spend waiting for the engine to answer before handing back a stream that is still being opened. Nothing can be subscribed to before the trigger, so a handler that starts publishing at once may be a chunk ahead of this; the race-free pattern is RunsClient::stream_by_metadata, opened before the run is triggered.

let run = task.run_no_wait(client, &(), RunOpts::default()).await?;
let mut chunks = run.stream().await?;
while let Some(chunk) = chunks.next().await {
    println!("{}", chunk?.payload);
}
// The output is separate from the result: this still waits for it.
let count = run.result().await?;
§Errors

Those of RunsClient::stream.

Source§

impl<O: DeserializeOwned> RunHandle<O>

Source

pub async fn result(&self) -> Result<O>

Waits for the run to finish and deserializes its output.

There is no time limit. A run that never finishes is waited for for ever, which is what the official SDKs do; wrap the call in tokio::time::timeout if that is not what you want. The wait costs nothing while it lasts — every wait on one client shares a single subscription — and dropping the future stops waiting without affecting the run.

Awaiting it more than once waits again, and a run that has already finished is answered straight away.

The subscription is the client’s, and a handle holds a clone of that client, so this goes on working after the Client the run was started from goes out of scope.

let run = task.run_no_wait(client, &(), RunOpts::default()).await?;
println!("started {}", run.id());

// An hour is this caller's own limit, not the SDK's.
let count = tokio::time::timeout(Duration::from_secs(3600), run.result())
    .await
    .expect("the run took more than an hour")?;
§Errors

Error::RunFailed when a task of the run reported an error, Error::RunCancelled when the run was cancelled before it finished — by cancel, by RunsClient::cancel, by a Concurrency limit that cancels rather than queues, or from the dashboard — Error::RunOutput when the run produced no output for this task or its output is not an O, and Error::ResultStream when the subscription was given up on — the run itself is unaffected by that last one, and waiting again opens a new subscription.

Trait Implementations§

Source§

impl<O> Clone for RunHandle<O>

Cloning a handle costs two strings and a reference; both clones wait on the same run.

Source§

fn clone(&self) -> Self

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<O> Debug for RunHandle<O>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<O> !RefUnwindSafe for RunHandle<O>

§

impl<O> !UnwindSafe for RunHandle<O>

§

impl<O> Forget for RunHandle<O>

§

impl<O> Freeze for RunHandle<O>
where PhantomData<fn() -> O>: Freeze,

§

impl<O> Move for RunHandle<O>

§

impl<O> Send for RunHandle<O>
where PhantomData<fn() -> O>: Send,

§

impl<O> Sync for RunHandle<O>
where PhantomData<fn() -> O>: Sync,

§

impl<O> Unpin for RunHandle<O>
where PhantomData<fn() -> O>: Unpin,

§

impl<O> UnsafeUnpin for RunHandle<O>
where PhantomData<fn() -> O>: UnsafeUnpin,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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