Struct ErrorRecord 

#[non_exhaustive]
pub struct ErrorRecord {
    pub code: String,
    pub message: String,
    pub path: Option<String>,
    pub workflow_id: Option<Arc<str>>,
    pub task_id: Option<Arc<str>>,
    pub timestamp: Option<Arc<str>>,
    pub detail: Option<String>,
    pub element_index: Option<usize>,
    pub cause: Option<Arc<ExprCause>>,
    pub site: Option<Arc<ErrorSite>>,
}

One error record, written as v3 wrote one: the same keys, in the same order, each optional one absent when unset. The engine stamps every record a task adds with the workflow’s and the task’s ids and the run’s timestamp, keeping any the record already carries; a workflow’s own failure carries no task id.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: String

The error code.

message: String

The human-readable message.

path: Option<String>

Where the error happened; null when not known, and never absent.

workflow_id: Option<Arc<str>>

The workflow it happened in, shared with the program’s own id and the audit entry’s, so a run allocates it once.

task_id: Option<Arc<str>>

The task it happened in, shared as workflow_id is.

timestamp: Option<Arc<str>>

When it happened, shared with every record of the run.

detail: Option<String>

Operator-only detail; never to be shown to an untrusted caller.

element_index: Option<usize>

The fan-out element the error came from.

cause: Option<Arc<ExprCause>>

Structured expression diagnostics, carried in-memory for host reports and omitted from the sanitized wire representation.

site: Option<Arc<ErrorSite>>

Where in the workflow the error happened, carried in-memory for host reports and omitted from the sanitized wire representation.

Implementations

impl ErrorRecord

pub fn new(code: impl Into<String>, message: impl Into<String>) -> Self

A record with a code and a message and nothing else.

pub fn cause(&self) -> Option<&ExprCause>

Structured expression diagnostics, when this record came from an expression or a budget failure.

pub fn with_cause(self, cause: ExprCause) -> Self

Attaches structured expression diagnostics to this record.

pub fn site(&self) -> Option<&ErrorSite>

Where in the workflow this error happened, when known.

pub fn with_site(self, site: ErrorSite) -> Self

Attaches the workflow site where this error happened.

Trait Implementations

impl Clone for ErrorRecord

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ErrorRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ErrorRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ErrorRecord

impl From<&Error> for ErrorRecord

fn from(error: &Error) -> Self

Converts to this type from the input type.

impl PartialEq for ErrorRecord

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ErrorRecord

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

where __S: Serializer,

Serialize this value into the given Serde serializer.