simple_dot 0.1.1

Simple API for creating GraphViz DOT files.
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

/*!
One-line description.

More detailed description, with

# Example

 */

use std::fmt::{Debug, Display};

// ------------------------------------------------------------------------------------------------
// Public Macros
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

#[derive(Debug)]
pub enum Error {
    InvalidValue {
        type_name: String,
        value_as_string: String,
    },
    IoError {
        source: std::io::Error,
    },
    Utf8Error {
        source: std::string::FromUtf8Error,
    },
}

// ------------------------------------------------------------------------------------------------
// Public Functions
// ------------------------------------------------------------------------------------------------

#[inline]
pub fn invalid_value(type_name: &str, value: &impl Debug) -> Error {
    Error::InvalidValue {
        type_name: type_name.to_string(),
        value_as_string: format!("{:?}", value),
    }
}

#[inline]
pub fn io_error(source: std::io::Error) -> Error {
    Error::IoError { source }
}

#[inline]
pub fn utf8_error(source: std::string::FromUtf8Error) -> Error {
    Error::Utf8Error { source }
}

// ------------------------------------------------------------------------------------------------
// Private Types
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Implementations
// ------------------------------------------------------------------------------------------------

impl Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{}",
            match self {
                Error::InvalidValue {
                    type_name,
                    value_as_string,
                } => format!("Invalid value `{}` for type {}", value_as_string, type_name),
                Error::IoError { source } =>
                    format!("An I/O error occurred; source: `{:?}`", source),
                Error::Utf8Error { source } => format!(
                    "An error occurred converting to UTF-8 text; source: `{:?}`",
                    source
                ),
            }
        )
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Error::IoError { source } => Some(source),
            Error::Utf8Error { source } => Some(source),
            _ => None,
        }
    }
}

impl From<std::io::Error> for Error {
    fn from(source: std::io::Error) -> Self {
        io_error(source)
    }
}

impl From<std::string::FromUtf8Error> for Error {
    fn from(source: std::string::FromUtf8Error) -> Self {
        utf8_error(source)
    }
}

// ------------------------------------------------------------------------------------------------
// Private Functions
// ------------------------------------------------------------------------------------------------

// ------------------------------------------------------------------------------------------------
// Modules
// ---------------------------------------------------------------------------------------