Struct azure_functions::bindings::DurableOrchestrationContext

pub struct DurableOrchestrationContext {
    pub instance_id: String,
    pub parent_instance_id: Option<String>,
    pub input: Value,
    // some fields omitted
}

Represents the Durable Functions orchestration context binding.

The following binding attributes are supported:

Name	Description
name	The name of the parameter being bound.
orchestration	The name of the orchestration. Defaults to the name of the function.

Examples

Calling multiple activities and waiting for them all to complete:

use azure_functions::{bindings::DurableOrchestrationContext, durable::OrchestrationOutput, func};
use serde_json::Value;
use log::error;

#[func]
pub async fn run(context: DurableOrchestrationContext) -> OrchestrationOutput {
    let activities = vec![
        context.call_activity("say_hello", "Tokyo"),
        context.call_activity("say_hello", "London"),
        context.call_activity("say_hello", "Seattle"),
    ];

    context.set_custom_status("Waiting for all activities to complete.");

    let result: Value = context
        .join_all(activities)
        .await
        .into_iter()
        .filter_map(|r| {
            r.map(Some).unwrap_or_else(|e| {
                error!("Activity failed: {}", e);
                None
            })
        })
        .collect::<Vec<_>>()
        .into();

    context.set_custom_status("All activities have completed.");

    result.into()
}

Fields

instance_id: String

The orchestration instance identifier.

parent_instance_id: Option<String>

The parent orchestration instance identifier.

input: Value

The input value to the orchestration.

Methods

impl DurableOrchestrationContext

pub fn is_replaying(&self) -> bool

Gets a value indicating whether the orchestrator function is currently replaying itself.

pub fn current_time(&self) -> DateTime<Utc>

Gets the current date/time in a way that is safe for use by orchestrator functions.

pub fn set_custom_status<S>(&self, status: S) where
    S: Into<Value>, 

Sets the custom status of the orchestration.

pub fn new_guid(&self) -> Uuid

Create a new deterministic GUID suitable for use with orchestrations.

Important traits for JoinAll<F>

impl<F> Future for JoinAll<F> where
    F: OrchestrationFuture,  type Output = Vec<F::Output>;

#[must_use = "futures do nothing unless you `.await` or poll them"] pub fn join_all<I>(&self, iter: I) -> JoinAll<I::Item> where
    I: IntoIterator,
    I::Item: OrchestrationFuture, 

Creates a future which represents a collection of the outputs of the futures given.

The returned future will drive execution for all of its underlying futures, collecting the results into a destination Vec<T> in the same order as they were provided.

Important traits for SelectAll<F>

impl<F> Future for SelectAll<F> where
    F: OrchestrationFuture + Unpin,  type Output = (F::Output, usize, Vec<F>);

pub fn select_all<I>(&self, iter: I) -> SelectAll<I::Item> where
    I: IntoIterator,
    I::Item: OrchestrationFuture, 

Creates a new future which will select over a list of futures.

The returned future will wait for any future within iter to be ready. Upon completion the item resolved will be returned, along with the index of the future that was ready and the list of all the remaining futures.

Panics

This function will panic if the iterator specified contains no items.

Important traits for ActionFuture<T>

impl<T> Future for ActionFuture<T> where
    T: Unpin,  type Output = T;

#[must_use = "futures do nothing unless you `.await` or poll them"] pub fn call_activity<D>(
    &self,
    activity_name: &str,
    data: D
) -> ActionFuture<Result<Value, String>> where
    D: Into<Value>, 

Schedules an activity function for execution.

Important traits for ActionFuture<T>

impl<T> Future for ActionFuture<T> where
    T: Unpin,  type Output = T;

#[must_use = "futures do nothing unless you `.await` or poll them"] pub fn call_activity_with_retry<D>(
    &self,
    activity_name: &str,
    data: D,
    retry_options: RetryOptions
) -> ActionFuture<Result<Value, String>> where
    D: Into<Value>, 

Schedules an activity function for execution with retry options.

Important traits for ActionFuture<T>

impl<T> Future for ActionFuture<T> where
    T: Unpin,  type Output = T;

#[must_use = "futures do nothing unless you `.await` or poll them"] pub fn call_sub_orchestrator<D>(
    &self,
    function_name: &str,
    instance_id: Option<String>,
    data: D
) -> ActionFuture<Result<Value, String>> where
    D: Into<Value>, 

Schedules an orchestration function for execution.

Important traits for ActionFuture<T>

impl<T> Future for ActionFuture<T> where
    T: Unpin,  type Output = T;

#[must_use = "futures do nothing unless you `.await` or poll them"] pub fn call_sub_orchestrator_with_retry<D>(
    &self,
    function_name: &str,
    instance_id: Option<String>,
    data: D,
    retry_options: RetryOptions
) -> ActionFuture<Result<Value, String>> where
    D: Into<Value>, 

Schedules an orchestration function for execution with retry.

pub fn continue_as_new<D>(&self, input: D, preserve_unprocessed_events: bool) where
    D: Into<Value>, 

Restarts the orchestration by clearing its history.

Important traits for ActionFuture<T>

impl<T> Future for ActionFuture<T> where
    T: Unpin,  type Output = T;

#[must_use = "futures do nothing unless you `.await` or poll them"] pub fn create_timer(&self, fire_at: DateTime<Utc>) -> ActionFuture<()>

Creates a durable timer that expires at a specified time.

Important traits for ActionFuture<T>

impl<T> Future for ActionFuture<T> where
    T: Unpin,  type Output = T;

pub fn wait_for_event(&self, name: &str) -> ActionFuture<Result<Value, String>>

Wait for an external event of the given name.