dpcs 0.13.1

Reference implementation of the Data Pipeline Contract Standard (DPCS)
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

//! Pipeline step model.

use serde::{Deserialize, Serialize};

use super::ExtensionMap;

/// Logical unit of work within a Pipeline Contract.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase")]
pub struct PipelineStep {
    /// Stable step identifier unique within the contract.
    pub id: String,
    /// Step type (for example `dtcs:transform` or an extension type).
    #[serde(rename = "type")]
    pub step_type: String,
    /// Optional human-readable name.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Reference to a contract that defines step behavior.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub contract_ref: Option<String>,
    /// Reference to a DTCS transform contract.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub transform_ref: Option<String>,
    /// Declared step inputs.
    #[serde(default)]
    pub inputs: Vec<StepPort>,
    /// Declared step outputs.
    #[serde(default)]
    pub outputs: Vec<StepPort>,
    /// Extension fields.
    #[serde(default, flatten)]
    pub extensions: ExtensionMap,
}

impl PipelineStep {
    /// Returns the input port with the given identifier, if declared.
    pub fn input_port(&self, id: &str) -> Option<&StepPort> {
        self.inputs.iter().find(|port| port.id == id)
    }

    /// Returns the output port with the given identifier, if declared.
    pub fn output_port(&self, id: &str) -> Option<&StepPort> {
        self.outputs.iter().find(|port| port.id == id)
    }
}

/// Input or output port declared on a pipeline step.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[cfg_attr(feature = "jsonschema", derive(schemars::JsonSchema))]
#[serde(rename_all = "camelCase")]
pub struct StepPort {
    /// Port identifier.
    pub id: String,
    /// Optional contract reference for the port.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub contract_ref: Option<String>,
    /// Extension fields.
    #[serde(default, flatten)]
    pub extensions: ExtensionMap,
}