ucsi 0.1.0

SI-based unit typing system
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
146

/// **Note:** Use the alias `ucsi::macros::unit_def::si_associated_unit_def`.
/// 
/// ## Syntax
/// 
/// ```rust,ignore
/// si_associated_unit_def! {
///     alias visibility? mod alias_mod_name;
/// 
///     /// add docs here...
///     unit UnitName
///     based on BaseUnitType {
///         // unit static configuration
///         // see `ucsi::core::units::associated::SiAssociatedUnitDefinition`.
///     }
///     alias alias1, alias2, ... ?
///     conversion {
///         const? (#[attr]* ty1, #[attr]* ty2, ...) {
///             to: |val| { ... },
///             from: |val| { ... },
///         };
///         ...
///     };
/// 
///     ...
/// }
/// ```
#[macro_export]
macro_rules! __impl_si_associated_unit_def {
    (
        alias $vis:vis mod $mod:ident;
        $(
            $(#[$attr:meta])*
            unit $name:ident
            based on $ty:ty {
                $($key:ident: $val:expr),*
                $(,)?
            }
            $(alias $($al:ident),+)?
            $(conversion $block_tt:tt)?;
        )+
    ) => {
        $(
            #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
            $(#[$attr])*
            pub struct $name;
    
            impl $crate::core::units::associated::SiAssociatedUnit for $name {
                type BaseUnit = $ty;
                const DEF: $crate::core::units::associated::SiAssociatedUnitDefinition =
                    $crate::core::units::associated::SiAssociatedUnitDefinition {
                        $($key: $val),*
                    };
            }
    
            impl $crate::core::units::any::SiDefinedUnit for $name {
                const DEF: ::core::option::Option<$crate::core::units::any::SiDefinedUnitDefinition> =
                    ::core::option::Option::Some($crate::core::units::any::SiDefinedUnitDefinition {
                        full_name: <$name as $crate::core::units::associated::SiAssociatedUnit>::DEF.full_name,
                        short_name: <$name as $crate::core::units::associated::SiAssociatedUnit>::DEF.short_name,
                        unit_symbol: <$name as $crate::core::units::associated::SiAssociatedUnit>::DEF.unit_symbol,
                    });
            }
    
            impl $crate::core::units::any::SiAnyUnit for $name {}

            $($crate::__impl_unit_conversion! { $name $block_tt; })?
        )+
        
        $($(
            $vis mod $mod {
                #[allow(non_camel_case_types)]
                $(pub type $al = super::$name;)+
            }
        )?)+
    };
}

/// **Note:** Use the alias `ucsi::macros::unit_def::si_exported_unit_def`.
/// 
/// ## Syntax
/// 
/// ```rust,ignore
/// si_exported_unit_def! {
///     alias visibility? mod alias_mod_name;
/// 
///     /// add docs here...
///     unit UnitName
///     based on BaseUnitType {
///         // unit static configuration
///         // see `ucsi::core::units::associated::SiAssociatedUnitDefinition`.
///     }
///     alias alias1, alias2, ... ?;
/// 
///     ...
/// }
/// ```
#[macro_export]
macro_rules! __impl_si_exported_unit_def {
    (
        alias $vis:vis mod $mod:ident;
        $(
            $(#[$attr:meta])*
            unit $name:ident based on $ty:ty {
                $($key:ident: $val:expr),*
                $(,)?
            } $(alias $($al:ident),+ $(,)?)?;
        )+
    ) => {
        $(
            #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
            $(#[$attr])*
            pub struct $name;

            impl $crate::core::units::exported::SiExportedUnit for $name {
                type BaseUnit = $ty;
                const DEF: $crate::core::units::exported::SiExportedUnitDefinition =
                    $crate::core::units::exported::SiExportedUnitDefinition {
                        $($key: $val),*
                    };
            }

            impl $crate::core::units::any::SiDefinedUnit for $name {
                const DEF: ::core::option::Option<$crate::core::units::any::SiDefinedUnitDefinition> =
                    ::core::option::Option::Some($crate::core::units::any::SiDefinedUnitDefinition {
                        full_name: <$name as $crate::core::units::exported::SiExportedUnit>::DEF.full_name,
                        short_name: <$name as $crate::core::units::exported::SiExportedUnit>::DEF.short_name,
                        unit_symbol: <$name as $crate::core::units::exported::SiExportedUnit>::DEF.unit_symbol,
                    });
            }

            impl $crate::core::units::any::SiOpsUnit for $name {
                const UNIT_MAP: $crate::core::units::base::BaseUnitMap =
                    <$name as $crate::core::units::exported::SiExportedUnit>::BaseUnit::UNIT_MAP;
            }

            impl $crate::core::units::any::SiAnyUnit for $name {}
        )+
        
        $($(
            $vis mod $mod {
                #[allow(non_camel_case_types)]
                $(pub type $al = super::$name;)+
            }
        )?)+
    };
}