corlib 0.4.1

A various ideas library
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191

//!
//! This module mostly contains functions that return cargo environment variables.
//! 
//! <https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates>
//! 
//! Excludes those environment variables only used during compilation.
//! 

//https://nrsk.dev/articles/capturing-doc-comments

//($(#[$attr:meta])* )

/*
///
/// Fetches the value associated with the $name environment variable.
/// 
 */

#[macro_export]
macro_rules! impl_cargo_env_accessor
{

    ($fn_name:ident, $name:ident) =>
    {

        #[doc = "Fetches the value associated with the "]
        #[doc = stringify!($name)]
        #[doc = " environment variable."]
        pub fn $fn_name() -> &'static str
        {

            env!(stringify!($name))

        }

    }

}

#[macro_export]
macro_rules! impl_cargo_env_accessor_pair
{

    ($fn_name:ident, $name:ident) =>
    {

        #[doc = "Fetches the value associated with the "]
        #[doc = stringify!($name)]
        #[doc = " environment variable. Returns a tuple with the name of the environment variable used in the first position and the value retrieved in the second position."]
        pub fn $fn_name() -> (&'static str, &'static str)
        {

            (stringify!($name), env!(stringify!($name)))

            //expected string literal

            /*
            let name = stringify!($name);

            (name, env!(name))
            */

        }

    }

}

//https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-crates

impl_cargo_env_accessor!(cargo, CARGO);

impl_cargo_env_accessor_pair!(cargo_pair, CARGO);



impl_cargo_env_accessor!(cargo_manifest_dir, CARGO_MANIFEST_DIR);

impl_cargo_env_accessor_pair!(cargo_manifest_dir_pair, CARGO_MANIFEST_DIR);



impl_cargo_env_accessor!(cargo_manifest_path, CARGO_MANIFEST_PATH);

impl_cargo_env_accessor_pair!(cargo_manifest_path_pair, CARGO_MANIFEST_PATH);



impl_cargo_env_accessor!(cargo_pkg_version, CARGO_PKG_VERSION);

impl_cargo_env_accessor_pair!(cargo_pkg_version_pair, CARGO_PKG_VERSION);



impl_cargo_env_accessor!(cargo_pkg_version_major, CARGO_PKG_VERSION_MAJOR);

impl_cargo_env_accessor_pair!(cargo_pkg_version_major_pair, CARGO_PKG_VERSION_MAJOR);



impl_cargo_env_accessor!(cargo_pkg_version_minor, CARGO_PKG_VERSION_MINOR);

impl_cargo_env_accessor_pair!(cargo_pkg_version_minor_pair, CARGO_PKG_VERSION_MINOR);



impl_cargo_env_accessor!(cargo_pkg_version_patch, CARGO_PKG_VERSION_PATCH);

impl_cargo_env_accessor_pair!(cargo_pkg_version_patch_pair, CARGO_PKG_VERSION_PATCH);



impl_cargo_env_accessor!(cargo_pkg_version_pre, CARGO_PKG_VERSION_PRE);

impl_cargo_env_accessor_pair!(cargo_pkg_version_pre_pair, CARGO_PKG_VERSION_PRE);



impl_cargo_env_accessor!(cargo_pkg_authors, CARGO_PKG_AUTHORS);

impl_cargo_env_accessor_pair!(cargo_pkg_authors_pair, CARGO_PKG_AUTHORS);



impl_cargo_env_accessor!(cargo_pkg_name, CARGO_PKG_NAME);

impl_cargo_env_accessor_pair!(cargo_pkg_name_pair, CARGO_PKG_NAME);



impl_cargo_env_accessor!(cargo_pkg_description, CARGO_PKG_DESCRIPTION);

impl_cargo_env_accessor_pair!(cargo_pkg_description_pair, CARGO_PKG_DESCRIPTION);



impl_cargo_env_accessor!(cargo_pkg_homepage, CARGO_PKG_HOMEPAGE);

impl_cargo_env_accessor_pair!(cargo_pkg_homepage_pair, CARGO_PKG_HOMEPAGE);



impl_cargo_env_accessor!(cargo_pkg_repository, CARGO_PKG_REPOSITORY);

impl_cargo_env_accessor_pair!(cargo_pkg_repository_pair, CARGO_PKG_REPOSITORY);



impl_cargo_env_accessor!(cargo_pkg_license, CARGO_PKG_LICENSE);

impl_cargo_env_accessor_pair!(cargo_pkg_license_pair, CARGO_PKG_LICENSE);



impl_cargo_env_accessor!(cargo_pkg_license_file, CARGO_PKG_LICENSE_FILE);

impl_cargo_env_accessor_pair!(cargo_pkg_license_file_pair, CARGO_PKG_LICENSE_FILE);



impl_cargo_env_accessor!(cargo_pkg_rust_version, CARGO_PKG_RUST_VERSION);

impl_cargo_env_accessor_pair!(cargo_pkg_rust_version_pair, CARGO_PKG_RUST_VERSION);



impl_cargo_env_accessor!(cargo_pkg_readme, CARGO_PKG_README);

impl_cargo_env_accessor_pair!(cargo_pkg_readme_pair, CARGO_PKG_README);



//impl_cargo_env_accessor!(cargo_crate_name, CARGO_CRATE_NAME);

//impl_cargo_env_accessor!(cargo_bin_name, CARGO_BIN_NAME);

//impl_cargo_env_accessor!(out_dir, OUT_DIR);



/* 
impl_pub_env_accessor!
{

    ///
    /// Fetches the value associated with the CARGO envionement variable.
    /// 
    (cargo, CARGO)

}
*/