flowrs-core 1.0.2

Core components of the flowrs framework for directed graph workflows
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

use std::fmt::Display;
use thiserror::Error;

/// All possible errors that can occur in the flowrs framework
#[derive(Error, Debug, Clone)]
pub enum FlowrsError {
    /// Error related to node execution
    #[error("Node execution error: {0}")]
    NodeExecution(String),

    /// Error related to workflow execution
    #[error("Workflow execution error: {0}")]
    WorkflowExecution(String),

    /// Error when a node is not found in the workflow
    #[error("Node not found: {0}")]
    NodeNotFound(String),

    /// Error when an action transition is not defined
    #[error("No transition defined for action: {0}")]
    NoTransitionDefined(String),

    /// Error during serialization
    #[error("Serialization error: {0}")]
    SerializationError(String),

    /// Error during deserialization
    #[error("Deserialization error: {0}")]
    DeserializationError(String),

    /// Error during async task joining
    #[error("Task join error: {0}")]
    JoinError(String),

    /// A cycle was detected in the workflow
    #[error("Cycle detected in workflow execution")]
    WorkflowCycleDetected,

    /// Error in the workflow definition
    #[error("Workflow definition error: {0}")]
    WorkflowDefinitionError(String),

    /// Error during batch processing
    #[error("Batch processing error: {0}")]
    BatchProcessingError(String),

    /// Node returned an unexpected outcome
    #[error("Unexpected node outcome: {0}")]
    UnexpectedOutcome(String),

    /// Other generic errors
    #[error("{0}")]
    Other(String),
}

/// A specialized Result type for flowrs operations
pub type FlowrsResult<T> = Result<T, FlowrsError>;

impl FlowrsError {
    /// Create a new node execution error
    pub fn node_execution(node_id: impl Display, message: impl Display) -> Self {
        Self::NodeExecution(format!("Node {}: {}", node_id, message))
    }

    /// Create a new batch processing error
    pub fn batch_processing(
        message: impl Display,
        source: Box<dyn std::error::Error + Send + Sync>,
    ) -> Self {
        Self::BatchProcessingError(format!("{}: {}", message, source))
    }

    /// Create a new unexpected outcome error
    pub fn unexpected_outcome(message: impl Display) -> Self {
        Self::UnexpectedOutcome(message.to_string())
    }

    /// Create a new node not found error
    pub fn node_not_found(node_id: impl Display) -> Self {
        Self::NodeNotFound(node_id.to_string())
    }

    /// Create a new timeout error
    pub fn timeout(message: impl Display) -> Self {
        Self::Other(format!("Timeout: {}", message))
    }

    /// Check if this error is a timeout error
    pub fn is_timeout(&self) -> bool {
        match self {
            Self::Other(msg) => msg.starts_with("Timeout:"),
            _ => false,
        }
    }
}