bytary 0.1.0

A simple CLI tool for binary data manipulation
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

use bytary::convert::ConversionGraph;
use bytary::error::{BytaryError, BytaryResult};
use bytary::format::Format;
use bytary::utils::FormattedWriter;
use clap::Parser;
use std::io;
use strum::IntoEnumIterator;

/// A simple CLI tool for binary data manipulation
#[derive(Parser)]
#[command(version, about, long_about)]
struct BytaryArgs {
    /// List all supported formats and exit
    ///
    /// If set, all other arguments are ignored.
    #[arg(short, long, default_value_t = false)]
    list_formats: bool,

    /// Output format
    #[arg(default_value = "bytes")]
    to: String,

    /// Input format
    ///
    /// Default is bytes
    #[arg(default_value = "bytes")]
    from: String,

    /// Space interval between bytes
    ///
    /// 0 means no space
    #[arg(short, long = "space", default_value_t = 0)]
    space_interval: usize,

    /// Line wrap interval
    ///
    /// 0 means no line wrap
    #[arg(short, long = "wrap", default_value_t = 0)]
    wrap_interval: usize,

    /// Use verbose output
    #[arg(short, long, default_value_t = false)]
    verbose: bool,
}

fn bytary_cli(
    args: BytaryArgs,
    input: &mut dyn io::Read,
    output: &mut dyn io::Write,
) -> BytaryResult<()> {
    let graph = ConversionGraph::default();

    if args.list_formats {
        println!(
            "Available formats: {}",
            Format::iter()
                .filter(|to| graph.can_convert_between(&Format::default(), &to))
                .map(|f| f.to_string())
                .collect::<Vec<String>>()
                .join(", ")
        );
        return Ok(());
    }

    let to = Format::try_from(args.to.as_str())?;
    let from = Format::try_from(args.from.as_str())?;

    let path = graph
        .find_shortest_path(&from, &to)
        .ok_or(BytaryError::UnsupportedConversion(from, to))?;

    let converters = graph.path_to_converters(&path).unwrap();

    if args.verbose {
        if converters.is_empty() {
            eprintln!("Operation: Copy data")
        } else {
            eprintln!(
                "Operation: {}",
                path.iter()
                    .map(|f| f.to_string())
                    .collect::<Vec<String>>()
                    .join(" => ")
            )
        }
        eprintln!(
            "Formatting: space every {} bytes, break line every {} bytes",
            args.space_interval, args.wrap_interval
        );
    }

    let converter = match converters.is_empty() {
        true => ConversionGraph::get_copy_converter(),
        false => ConversionGraph::compose(converters),
    };

    let mut writer = FormattedWriter::new(output, args.space_interval, args.wrap_interval);
    Ok(converter(input, &mut writer)?)
}

fn main() {
    if let Err(e) = bytary_cli(BytaryArgs::parse(), &mut io::stdin(), &mut io::stdout()) {
        eprintln!("{}", e);
    }
}

#[cfg(test)]
mod test {
    use crate::*;
    use std::io::Cursor;

    #[test]
    fn test_cli_bytes_to_hex() {
        let mut output = Vec::new();
        bytary_cli(
            BytaryArgs {
                list_formats: false,
                to: "hex".to_string(),
                from: "bytes".to_string(),
                space_interval: 0,
                wrap_interval: 0,
                verbose: true,
            },
            &mut Cursor::new(vec![0x1b, 0x34, 0x8f, 0xff, 0x00, 0x0e]),
            &mut output,
        )
        .unwrap();
        assert_eq!(output, b"1b348fff000e");
    }

    #[test]
    fn test_bytes_to_bytes() {
        let mut output = Vec::new();
        let data = [0x1b, 0x34, 0x8f, 0xff, 0x00, 0x0e];
        bytary_cli(
            BytaryArgs {
                list_formats: false,
                to: "bytes".to_string(),
                from: "bytes".to_string(),
                space_interval: 0,
                wrap_interval: 0,
                verbose: true,
            },
            &mut Cursor::new(&data),
            &mut output,
        )
        .unwrap();
        assert_eq!(output, &data);
    }
}