Struct RunInfo

pub struct RunInfo {

    pub run_id: RunId,
    pub name: String,
    pub component_type: String,
    pub input: Value,
    pub output: Option<Value>,
    pub error: Option<String>,
    pub start_time: DateTime<Utc>,
    pub end_time: Option<DateTime<Utc>>,
    pub duration: Option<Duration>,
    pub tags: Vec<String>,
    pub metadata: HashMap<String, Value>,
    pub parent_run_id: Option<RunId>,
    pub child_run_ids: Vec<RunId>,
}

Information about a run

Fields

run_id: RunId

The run ID

name: String

The name of the component being run

component_type: String

The type of the component

input: Value

Input to the component

output: Option<Value>

Output from the component (if completed)

error: Option<String>

Error that occurred (if any)

start_time: DateTime<Utc>

Start time of the run

end_time: Option<DateTime<Utc>>

End time of the run (if completed)

duration: Option<Duration>

Duration of the run (if completed)

tags: Vec<String>

Tags associated with the run

metadata: HashMap<String, Value>

Metadata associated with the run

parent_run_id: Option<RunId>

Parent run ID (if this is a sub-run)

child_run_ids: Vec<RunId>

Child run IDs

Implementations

impl RunInfo

pub fn new( run_id: RunId, name: impl Into<String>, component_type: impl Into<String>, input: Value, ) -> Self

Create a new run info

pub fn complete_with_output(self, output: Value) -> Self

Mark the run as completed with output

pub fn complete_with_error(self, error: impl Into<String>) -> Self

Mark the run as failed with error

pub fn add_tag(self, tag: impl Into<String>) -> Self

Add a tag to the run

pub fn add_metadata(self, key: impl Into<String>, value: Value) -> Self

Add metadata to the run

pub fn with_parent(self, parent_run_id: RunId) -> Self

Set the parent run ID

pub fn add_child(self, child_run_id: RunId) -> Self

Add a child run ID

pub fn is_completed(&self) -> bool

Check if the run is completed

pub fn is_failed(&self) -> bool

Check if the run failed

pub fn is_successful(&self) -> bool

Check if the run succeeded

Trait Implementations

impl Clone for RunInfo

fn clone(&self) -> RunInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RunInfo

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RunInfo

fn eq(&self, other: &RunInfo) -> 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 Serializable for RunInfo

fn namespace() -> Vec<String>

Get the namespace for this serializable object

fn is_serializable() -> bool

Check if this object is serializable

fn to_json(&self) -> Result<String>

Serialize this object to JSON

fn to_json_pretty(&self) -> Result<String>

Serialize this object to a pretty-printed JSON string

fn from_json(json: &str) -> Result<Self>

where Self: Sized,

Deserialize this object from JSON

fn to_dict(&self) -> Result<HashMap<String, Value>>

Serialize this object to a dictionary (HashMap)

fn from_dict(dict: &HashMap<String, Value>) -> Result<Self>

where Self: Sized,

Deserialize this object from a dictionary (HashMap)

fn type_name() -> &'static str

Get the type name for this serializable object

impl Serialize for RunInfo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RunInfo