pipx 0.1.0

Composable pipelines for Rust with synchronous and asynchronous execution, middleware-style processing, and predictable data flow.
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

use thiserror::Error;

/// The centralized error type returned by public pipeline execution methods.
///
/// **Errors**
/// - `StepFailure` - Raised when a pipeline step fails with a specific message.
/// - `InputMissing` - Raised when the pipeline is executed without input.
/// - `DispatchError` - Raised when an invalid dispatch operation occurs.
/// - `RescueFailure` - Raised when a rescue handler itself fails.
/// - `Custom` - Wraps any external error that should leave the pipeline.
#[derive(Debug, Error)]
pub enum PipelineError {
    /// Raised when a pipeline step fails with a specific message.
    #[error(transparent)]
    StepFailure(#[from] StepFailure),

    /// Raised when the pipeline is executed without any input provided.
    #[error("Pipeline input not set")]
    InputMissing,

    /// Raised when an invalid or unsupported method dispatch occurs.
    #[error(transparent)]
    DispatchError(#[from] DispatchError),

    /// Raised when a rescue fallback closure itself fails.
    #[error(transparent)]
    RescueFailure(#[from] RescueFailure),

    /// Wraps any external error that should be propagated from the pipeline.
    #[error(transparent)]
    Custom(#[from] Box<dyn std::error::Error + Send + Sync>),
}

/// Represents a failure that occurred in a specific pipeline step.
///
/// **Parameters**
/// - `step` - The name of the step where the failure happened.
/// - `message` - A human-readable description of the failure.
#[derive(Debug, Error)]
#[error("Step `{step}` failed: {message}")]
pub struct StepFailure {
    /// The name of the step where the failure happened.
    pub step: &'static str,

    /// A human-readable description of the failure.
    pub message: String,
}

/// Represents a failure that occurred during a dispatch operation.
///
/// **Parameters**
/// - `method` - The name of the dispatch method that failed.
/// - `message` - A human-readable description of the failure.
#[derive(Debug, Error)]
#[error("Dispatch `{method}` error: {message}")]
pub struct DispatchError {
    /// The name of the dispatch method that failed.
    pub method: &'static str,

    /// A human-readable description of the failure.
    pub message: String,
}

/// Represents a failure that occurred during a rescue operation.
///
/// **Parameters**
/// - `rescue` - The name of the rescue handler that failed.
/// - `message` - A human-readable description of the failure.
#[derive(Debug, Error)]
#[error("Rescue `{rescue}` failed: {message}")]
pub struct RescueFailure {
    /// The name of the rescue handler that failed.
    pub rescue: &'static str,

    /// A human-readable description of the failure.
    pub message: String,
}