dpcs 0.13.0

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
63
64
65
66

//! Report output format identifiers.

use std::str::FromStr;

use crate::error::{Error, Result};

/// Supported report / export formats for CLI and library renderers.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum ReportFormat {
    /// Human-oriented plain or richly styled terminal text.
    #[default]
    Text,
    /// Pretty-printed JSON.
    Json,
    /// Markdown document.
    Markdown,
    /// Self-contained HTML document.
    Html,
    /// Mermaid flowchart source.
    Mermaid,
    /// Graphviz DOT source.
    Dot,
}

impl ReportFormat {
    /// Parse from a CLI flag value (`text`, `json`, `markdown`, `html`, `mermaid`, `dot`).
    pub fn parse(value: &str) -> Result<Self> {
        value.parse()
    }

    /// Returns `true` when this format is a graph export.
    pub fn is_graph_export(self) -> bool {
        matches!(self, Self::Mermaid | Self::Dot)
    }
}

impl FromStr for ReportFormat {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self> {
        match s.trim().to_ascii_lowercase().as_str() {
            "text" | "plain" => Ok(Self::Text),
            "json" => Ok(Self::Json),
            "markdown" | "md" => Ok(Self::Markdown),
            "html" => Ok(Self::Html),
            "mermaid" => Ok(Self::Mermaid),
            "dot" | "graphviz" => Ok(Self::Dot),
            other => Err(Error::Serialization(format!(
                "unknown report format `{other}` (expected text|json|markdown|html|mermaid|dot)"
            ))),
        }
    }
}

impl std::fmt::Display for ReportFormat {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(match self {
            Self::Text => "text",
            Self::Json => "json",
            Self::Markdown => "markdown",
            Self::Html => "html",
            Self::Mermaid => "mermaid",
            Self::Dot => "dot",
        })
    }
}