pub struct ExternalWorkflowHandle { /* private fields */ }Expand description
Handle to an external workflow for sending signals or requesting cancellation.
Obtained via SyncWorkflowContext::external_workflow or
WorkflowContext::external_workflow.
Implementations§
Source§impl ExternalWorkflowHandle
impl ExternalWorkflowHandle
Sourcepub fn workflow_id(&self) -> &str
pub fn workflow_id(&self) -> &str
The workflow ID of the external workflow.
Sourcepub fn run_id(&self) -> Option<&str>
pub fn run_id(&self) -> Option<&str>
The run ID of the external workflow, or None if targeting the latest run.
Sourcepub fn signal<S: SignalDefinition>(
&self,
signal: S,
input: S::Input,
) -> impl CancellableFuture<SignalExternalWfResult> + 'static
pub fn signal<S: SignalDefinition>( &self, signal: S, input: S::Input, ) -> impl CancellableFuture<SignalExternalWfResult> + 'static
Send a signal to the external workflow.
Sourcepub fn cancel(
&self,
reason: Option<String>,
) -> impl FusedFuture<Output = CancelExternalWfResult>
pub fn cancel( &self, reason: Option<String>, ) -> impl FusedFuture<Output = CancelExternalWfResult>
Request cancellation of the external workflow.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for ExternalWorkflowHandle
impl !RefUnwindSafe for ExternalWorkflowHandle
impl !Send for ExternalWorkflowHandle
impl !Sync for ExternalWorkflowHandle
impl Unpin for ExternalWorkflowHandle
impl UnsafeUnpin for ExternalWorkflowHandle
impl !UnwindSafe for ExternalWorkflowHandle
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
Wrap the input message
T in a tonic::Request