src/macros.rs


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

//! Auxiliary macros.


/// Create trait implementations for an error type.
macro_rules! error_type {
    (
        $this:ident: $type:ident,
        $(res: $res:ident,)*
        show: $f:ident => $show:expr,
        $(source: $source:expr,)*
        $(from: ($err:ident: $from:path, $conv:expr),)*
    ) => {
        // Possibly create a result type.
        $(type $res<T> = std::result::Result<T, $type>;)*

        impl std::fmt::Display for $type {
            fn fmt(&$this, $f: &mut std::fmt::Formatter) -> std::fmt::Result {
                $show
            }
        }

        debug_display!($type);

        impl std::error::Error for $type {
            // The source method is only generated if an implementation was given.
            $(fn source(&$this) -> Option<&(dyn std::error::Error + 'static)> {
                $source
            })*
        }

        // Create any number of from implementations.
        $(impl From<$from> for $type {
            fn from($err: $from) -> $type {
                $conv
            }
        })*
    };
}

/// Create a `Debug` implementation from a `Display` implementation.
macro_rules! debug_display {
    ($type:ident) => (
        impl std::fmt::Debug for $type {
            fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
                std::fmt::Display::fmt(self, f)
            }
        }
    );
    ($type:ident; $generics:tt where $($bounds:tt)*) => (
        impl<$generics> std::fmt::Debug for $type<$generics> where $($bounds)* {
            fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
                std::fmt::Display::fmt(self, f)
            }
        }
    );
}

/// Declare a module and reexport all its contents.
macro_rules! pub_use_mod {
    ($name:ident) => {
        mod $name;
        pub use $name::*;
    };
}