Enum CancelFlowResult 

pub enum CancelFlowResult {
    Cancelled {
        cancellation_policy: String,
        member_execution_ids: Vec<String>,
    },
    CancellationScheduled {
        cancellation_policy: String,
        member_count: u32,
        member_execution_ids: Vec<String>,
    },
    PartiallyCancelled {
        cancellation_policy: String,
        member_execution_ids: Vec<String>,
        failed_member_execution_ids: Vec<String>,
    },
}

Variants

Cancelled

Flow cancelled and all member cancellations (if any) have completed synchronously. Used when cancellation_policy != "cancel_all", when the flow has no members, when the caller opted into synchronous dispatch (e.g. ?wait=true), or when the flow was already in a terminal state (idempotent retry).

On the idempotent-retry path member_execution_ids may be capped at the server (default 1000 entries) to bound response bandwidth on flows with very large membership. The first (non-idempotent) call always returns the full list, so clients that need every member id should persist the initial response.

Fields

cancellation_policy: String

member_execution_ids: Vec<String>

CancellationScheduled

Flow state was flipped to cancelled atomically, but member cancellations are dispatched asynchronously in the background. Clients may poll GET /v1/executions/{id}/state for each member execution id to track terminal state.

Fields

cancellation_policy: String

member_count: u32

member_execution_ids: Vec<String>

PartiallyCancelled

?wait=true dispatch completed but one or more member cancellations failed mid-loop (e.g. ghost member, Lua error, transport fault after retries exhausted). The flow itself is still flipped to cancelled (atomic Lua already ran); callers SHOULD inspect failed_member_execution_ids and either retry those ids directly via cancel_execution or wait for the cancel-backlog reconciler to retry them in the background.

Only emitted by the synchronous wait path ([crate::CancelFlowArgs] via ?wait=true). The async path returns CancelFlowResult::CancellationScheduled and delegates retries to the reconciler — there is no visible “partial” state on the async path because the dispatch result is not observed inline.

Fields

cancellation_policy: String

member_execution_ids: Vec<String>

All member execution ids that the cancel_flow FCALL returned (i.e. the full membership at the moment of cancellation).

failed_member_execution_ids: Vec<String>

Strict subset of member_execution_ids whose per-member cancel FCALL returned an error. Order is deterministic (matches the iteration order over member_execution_ids).

Trait Implementations

impl Clone for CancelFlowResult

fn clone(&self) -> CancelFlowResult

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CancelFlowResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CancelFlowResult

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CancelFlowResult

fn eq(&self, other: &CancelFlowResult) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CancelFlowResult

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CancelFlowResult

impl StructuralPartialEq for CancelFlowResult