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
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

use std::process::{Command, Stdio};

use sanitation::SString;

use crate::errors::{Error, Result};
use crate::fs::Path;

/// Utility function to spawn a command from a string rather than
/// array of arguments.
///
/// Returns a triple with `(exit code, stdout, stderr)`
pub fn shell_command_vec_output(
    command: impl std::fmt::Display,
    current_dir: impl Into<Path>,
) -> Result<(i32, Vec<u8>, Vec<u8>)> {
    let args = split_args(&command.to_string());
    let mut cmd = Command::new(args[0].clone());
    let cmd = cmd.current_dir(Into::<Path>::into(current_dir));
    let cmd = cmd.args(args[1..].to_vec());
    let cmd = cmd.stdin(Stdio::null());
    let cmd = cmd.stdout(Stdio::piped());
    let cmd = cmd.stderr(Stdio::piped());
    let child = cmd.spawn()?;
    let output = child.wait_with_output()?;
    let status = output.status.code().unwrap_or_default();
    Ok((status, output.stdout.to_vec(), output.stderr.to_vec()))
}

/// Utility function to spawn a command from a string rather than
/// array of arguments and returns strings for stdout and stderr
/// rather than [`Vec<u8>`]. Stdout and Stderr are sanitized for memory
/// safety during [`String`] conversion.
///
/// Returns a triple with `(exit code, stdout, stderr)`
pub fn shell_command_string_output(
    command: impl std::fmt::Display,
    current_dir: impl Into<Path>,
) -> Result<(i32, String, String)> {
    let (status, stdout, stderr) = shell_command_vec_output(command, current_dir)?;
    let stdout = SString::new(&stdout).safe()?;
    let stderr = SString::new(&stderr).safe()?;
    Ok((status, stdout, stderr))
}

/// Utility function to spawn a command from a string rather than
/// array of arguments and returns the exit code. Stdout and Stderr
/// are inherited from the current process.
pub fn shell_command(command: impl std::fmt::Display, current_dir: impl Into<Path>) -> Result<i32> {
    let args = split_args(&command.to_string());
    let mut cmd = Command::new(args[0].clone());
    let cmd = cmd.current_dir(Into::<Path>::into(current_dir));
    let cmd = cmd.args(args[1..].to_vec());
    let cmd = cmd.stdin(Stdio::null());
    let cmd = cmd.stdout(Stdio::inherit());
    let cmd = cmd.stderr(Stdio::inherit());
    let child = cmd.spawn()?;
    let output = child.wait_with_output()?;
    let status = output.status.code().unwrap_or_default();
    Ok(status)
}

/// `shell_command_stdout` executes the given command and returns the
/// stdout of the process.
pub fn shell_command_stdout(
    command: impl std::fmt::Display,
    current_dir: impl Into<Path>,
) -> Result<String> {
    let (exit_code, stdout, _) = shell_command_string_output(command.to_string(), current_dir)?;
    match exit_code {
        0 => Ok(stdout),
        _ => Err(Error::SubprocessError(format!(
            "command {:#?} failed with {}",
            command.to_string(),
            exit_code
        ))),
    }
}

fn split_args(args: &str) -> Vec<String> {
    match shlex::split(args) {
        Some(args) => args.iter().map(|arg| arg.to_string()).collect::<Vec<String>>(),
        None => vec![args.to_string()],
    }
}