pub struct WorkflowRunSummary { /* private fields */ }Expand description
Aggregate outcome for one workflow run.
Implementations§
Source§impl WorkflowRunSummary
impl WorkflowRunSummary
Sourcepub const fn new(scheduled_node_count: usize) -> Self
pub const fn new(scheduled_node_count: usize) -> Self
Start an empty summary for a run with scheduled_node_count nodes.
Sourcepub const fn terminal_state(&self) -> WorkflowTerminalState
pub const fn terminal_state(&self) -> WorkflowTerminalState
Terminal state after all scheduled node runs were observed.
Sourcepub const fn scheduled_node_count(&self) -> usize
pub const fn scheduled_node_count(&self) -> usize
Number of nodes scheduled for execution.
Sourcepub const fn completed_node_count(&self) -> usize
pub const fn completed_node_count(&self) -> usize
Number of nodes that completed successfully.
Sourcepub const fn failed_node_count(&self) -> usize
pub const fn failed_node_count(&self) -> usize
Number of nodes that returned a non-cancellation error.
Sourcepub const fn cancelled_node_count(&self) -> usize
pub const fn cancelled_node_count(&self) -> usize
Number of nodes that returned a cancellation error.
Sourcepub const fn observed_message_count(&self) -> usize
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.
Sourcepub const fn error_count(&self) -> usize
pub const fn error_count(&self) -> usize
Number of node results that ended in an error.
Sourcepub const fn pending_node_count(&self) -> usize
pub const fn pending_node_count(&self) -> usize
Number of scheduled nodes that have not yet reached a terminal state.
Sourcepub const fn first_error(&self) -> Option<&PureflowError>
pub const fn first_error(&self) -> Option<&PureflowError>
First error observed by the workflow runner, if any.
Sourcepub const fn deadlock_diagnostic(&self) -> Option<&WorkflowDeadlockDiagnostic>
pub const fn deadlock_diagnostic(&self) -> Option<&WorkflowDeadlockDiagnostic>
Deadlock diagnostic captured by the workflow watchdog, if it fired.
Sourcepub fn into_result(self) -> Result<()>
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
impl Clone for WorkflowRunSummary
Source§fn clone(&self) -> WorkflowRunSummary
fn clone(&self) -> WorkflowRunSummary
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for WorkflowRunSummary
impl Debug for WorkflowRunSummary
Source§impl PartialEq for WorkflowRunSummary
impl PartialEq for WorkflowRunSummary
Source§fn eq(&self, other: &WorkflowRunSummary) -> bool
fn eq(&self, other: &WorkflowRunSummary) -> bool
self and other values to be equal, and is used by ==.