iocore 3.1.0

IOCore is a safe library for unix CLI tools and Systems programming. IOCore provides the [`iocore::Path`] abstraction of file-system paths designed to replace most [`std::path`] and [`std::fs`] operations with practical methods, other abstractions include: - handling file-system permissions via [`iocore::PathPermissions`] powered by the crate [`trilobyte`]. - handling file-system timestamps via [`iocore::PathTimestamps`] granularly via [`iocore::PathDateTime`]. IOCore provides the [`iocore::walk_dir`] function and its companion trait [`iocore::WalkProgressHandler`] which traverses file-systems quickly via threads. IOcore provides [`iocore::User`] which provides unix user information such as uid, path to home etc. The module [`iocore::env`] provides [`iocore::env:args`] returns a [`Vec<String>`] from [`std::env:args`], and [`iocore::env:var`] that returns environment variables as string.
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

use crate::Error;

/// returns [`std::env::args`] as [`Vec<String>`]
pub fn args() -> Vec<String> {
    std::env::args().map(|c| c.to_string()).collect()
}

/// returns [`std::env::var`] as [`Result<String, Error>`] with either [`String`] or `Error::EnvironmentVarError`
pub fn var(key: impl std::fmt::Display) -> Result<String, Error> {
    let key = key.to_string();
    Ok(std::env::var(&key).map_err(|e| {
        Error::EnvironmentVarError(format!("obtaining environment variable {:#?}: {}", &key, e))
    })?)
}

/// `args_from_string` returns [`Vec<String>`] from split [`String`].
///
/// Example
///
/// ```
/// use iocore::args_from_string;
/// assert_eq!(args_from_string("a b/c  --flag  n/o/p "), vec!["a", "b/c", "--flag", "n/o/p"]);
/// ```
pub fn args_from_string(args: impl std::fmt::Display) -> Vec<String> {
    regex::Regex::new(r"\s+")
        .unwrap()
        .split(&args.to_string())
        .filter(|args| args.len() > 0)
        .map(|args| args.to_string())
        .collect::<Vec<String>>()
}
/// `env_var` macro calls `iocore::env::var`, returns empty string and prints warning to stderr if the given environment variable is not set.
///
/// Example:
///
/// ```
/// use iocore::env_var;
/// assert_eq!(env_var!("TZ"), "UTC");
/// ```
#[macro_export]
macro_rules! env_var {
    ($name:expr) => {{
        match $crate::env::var($name) {
            Ok(var) => var,
            Err(error) => {
                eprintln!("[warning] {}", error.to_string());
                String::new()
            },
        }
    }};
}