printable-shell-command 0.2.4

A helper library to print shell commands.
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

use std::str::Utf8Error;

use crate::FormattingOptions;

pub trait ShellPrintable {
    fn printable_invocation_string(&self) -> Result<String, Utf8Error>;
    // Calls `.to_string_lossy()` on the program name and args.
    fn printable_invocation_string_lossy(&self) -> String;

    // Print the invocation to `stdout`.`
    fn print_invocation(&mut self) -> Result<&mut Self, Utf8Error> {
        println!("{}", self.printable_invocation_string_lossy());
        Ok(self)
    }
    // Print the invocation to `stdout`.`
    fn print_invocation_lossy(&mut self) -> &mut Self {
        println!("{}", self.printable_invocation_string_lossy());
        self
    }
}

pub trait ShellPrintableWithOptions {
    fn printable_invocation_string_with_options(
        &self,
        formatting_options: FormattingOptions,
    ) -> Result<String, Utf8Error>;
    // Calls `.to_string_lossy()` on the program name and args.
    fn printable_invocation_string_lossy_with_options(
        &self,
        formatting_options: FormattingOptions,
    ) -> String;

    // Print the invocation to `stdout`.`
    fn print_invocation_with_options(
        &mut self,
        formatting_options: FormattingOptions,
    ) -> Result<&mut Self, Utf8Error> {
        println!(
            "{}",
            self.printable_invocation_string_lossy_with_options(formatting_options)
        );
        Ok(self)
    }
    // Print the invocation to `stdout`.`
    fn print_invocation_lossy_with_options(
        &mut self,
        formatting_options: FormattingOptions,
    ) -> &mut Self {
        println!(
            "{}",
            self.printable_invocation_string_lossy_with_options(formatting_options)
        );
        self
    }
}