Skip to main content

WorkflowRunSummary

Struct WorkflowRunSummary 

Source
pub struct WorkflowRunSummary { /* private fields */ }
Expand description

Aggregate outcome for one workflow run.

Implementations§

Source§

impl WorkflowRunSummary

Source

pub const fn new(scheduled_node_count: usize) -> Self

Start an empty summary for a run with scheduled_node_count nodes.

Source

pub const fn terminal_state(&self) -> WorkflowTerminalState

Terminal state after all scheduled node runs were observed.

Source

pub const fn scheduled_node_count(&self) -> usize

Number of nodes scheduled for execution.

Source

pub const fn completed_node_count(&self) -> usize

Number of nodes that completed successfully.

Source

pub const fn failed_node_count(&self) -> usize

Number of nodes that returned a non-cancellation error.

Source

pub const fn cancelled_node_count(&self) -> usize

Number of nodes that returned a cancellation error.

Source

pub const fn observed_message_count(&self) -> usize

Number of message observations accounted for by the workflow runner.

This remains zero until queue-pressure/message accounting is attached to the runner in the observability tranche.

Source

pub const fn error_count(&self) -> usize

Number of node results that ended in an error.

Source

pub const fn pending_node_count(&self) -> usize

Number of scheduled nodes that have not yet reached a terminal state.

Source

pub const fn first_error(&self) -> Option<&PureflowError>

First error observed by the workflow runner, if any.

Source

pub const fn deadlock_diagnostic(&self) -> Option<&WorkflowDeadlockDiagnostic>

Deadlock diagnostic captured by the workflow watchdog, if it fired.

Source

pub fn into_result(self) -> Result<()>

Convert a summary into the legacy Result<()> shape.

§Errors

Returns the first observed workflow error when the terminal state is not WorkflowTerminalState::Completed.

Trait Implementations§

Source§

impl Clone for WorkflowRunSummary

Source§

fn clone(&self) -> WorkflowRunSummary

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 Debug for WorkflowRunSummary

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for WorkflowRunSummary

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Eq for WorkflowRunSummary

Source§

impl StructuralPartialEq for WorkflowRunSummary

Auto Trait Implementations§

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

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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