wavedrom 0.1.0

A Pure Rust Digital Timing Diagram Generator based on WaveDrom-JS
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

#[cfg(feature = "json5")]
pub use self::json5::*;

#[cfg(feature = "serde_json")]
pub use self::serde_json::*;

#[cfg(feature = "json5")]
mod json5 {
    use std::error::Error;
    use std::fmt::Display;
    use std::io;

    use crate::svg::options::RenderOptions;
    use crate::PathAssembleOptions;

    /// An error with the [`render_json5`][crate::render_json5] or
    /// [`render_json5_with_options`][crate::render_json5_with_options] functions.
    #[derive(Debug)]
    pub enum RenderJson5Error {
        /// An error parsing the JSON
        Json(json5::Error),
        /// An error with the IO
        Io(io::Error),
    }

    /// Render the contents of a json5 file to a `writer`.
    #[inline]
    pub fn render_json5(json: &str, writer: &mut impl io::Write) -> Result<(), RenderJson5Error> {
        render_json5_with_options(
            json,
            writer,
            PathAssembleOptions::default(),
            &RenderOptions::default(),
        )
    }

    /// Render the contents of a json5 file to a `writer` with a specific set of options.
    pub fn render_json5_with_options(
        json: &str,
        writer: &mut impl io::Write,
        assemble_options: PathAssembleOptions,
        render_options: &RenderOptions,
    ) -> Result<(), RenderJson5Error> {
        let figure = crate::Figure::from_json5(json)?;
        let assembled = figure.assemble_with_options(assemble_options);
        assembled.write_svg_with_options(writer, render_options)?;

        Ok(())
    }

    impl From<json5::Error> for RenderJson5Error {
        #[inline]
        fn from(error: json5::Error) -> Self {
            Self::Json(error)
        }
    }

    impl From<io::Error> for RenderJson5Error {
        #[inline]
        fn from(error: io::Error) -> Self {
            Self::Io(error)
        }
    }

    impl Display for RenderJson5Error {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            match self {
                Self::Json(err) => err.fmt(f),
                Self::Io(err) => err.fmt(f),
            }
        }
    }

    impl Error for RenderJson5Error {}
}

#[cfg(all(feature = "serde", feature = "serde_json"))]
mod serde_json {
    use std::error::Error;
    use std::fmt::Display;
    use std::io;

    use crate::svg::options::RenderOptions;
    use crate::PathAssembleOptions;

    /// An error with the [`render_json`][crate::render_json] or
    /// [`render_json_with_options`][crate::render_json_with_options] functions.
    #[derive(Debug)]
    pub enum RenderJsonError {
        /// An error parsing the JSON
        Json(serde_json::error::Error),
        /// An error with the IO
        Io(io::Error),
    }

    /// Render the contents of a json file to a `writer`.
    #[inline]
    pub fn render_json(json: &str, writer: &mut impl io::Write) -> Result<(), RenderJsonError> {
        render_json_with_options(
            json,
            writer,
            PathAssembleOptions::default(),
            &RenderOptions::default(),
        )
    }

    /// Render the contents of a json file to a `writer` with a specific set of options.
    pub fn render_json_with_options(
        json: &str,
        writer: &mut impl io::Write,
        assemble_options: PathAssembleOptions,
        render_options: &RenderOptions,
    ) -> Result<(), RenderJsonError> {
        let figure = crate::Figure::from_json(json)?;
        let assembled = figure.assemble_with_options(assemble_options);
        assembled.write_svg_with_options(writer, render_options)?;

        Ok(())
    }

    impl From<serde_json::error::Error> for RenderJsonError {
        #[inline]
        fn from(error: serde_json::error::Error) -> Self {
            Self::Json(error)
        }
    }

    impl From<io::Error> for RenderJsonError {
        #[inline]
        fn from(error: io::Error) -> Self {
            Self::Io(error)
        }
    }

    impl Display for RenderJsonError {
        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
            match self {
                Self::Json(err) => err.fmt(f),
                Self::Io(err) => err.fmt(f),
            }
        }
    }

    impl Error for RenderJsonError {}
}