kex 0.2.6

Console application for streamed hex dumping
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

//! Formatting traits collection, including builtin formatters

use ascii::*;
use std::{cmp::min, io::Write};

pub mod address_fmt;
pub use address_fmt::*;

pub mod byte_fmt;
pub use byte_fmt::*;

pub mod char_fmt;
pub use char_fmt::*;

pub mod groupping;
pub use groupping::*;

use std::io::Result;

/// Used for row offset formatting
pub trait AddressFormatting {
    fn format<O: Write>(&self, addr: usize, out: &mut O) -> Result<()>;

    fn separators(&self) -> &Separators;
}

/// Used for raw bytes formatting
pub trait ByteFormatting {
    /// Requirement for byte portions passing in the `format(...)` function
    fn byte_order(&self) -> GroupAtomicity;

    fn groupping(&self) -> Groupping;

    fn bytes_per_row(&self) -> usize {
        self.groupping().bytes_per_row()
    }

    /// `bytes` - bytes to convert to `String`
    ///
    /// `byte_number_in_row` - number of byte in row (from where the `bytes` started formatting).
    /// It useful for determining, where to place group separators (if your formatter uses it)
    fn format<O: Write>(&self, bytes: &[u8], byte_number_in_row: usize, out: &mut O) -> Result<usize>;

    /// When writing data chunks to [`super::Printer`] is finished, last output line may be incomplete.
    /// This function should provide spacing string for incomplete row
    ///
    /// ## Note
    /// For the flexibility purpose (for example, you may need add ANSI color codes to output data),
    /// there are no strict checking for printable byte format length.
    /// Getting the spacing string with incorrect length will result with inaccurate output
    ///
    /// ### Parameters
    /// `byte_count` - missing bytes, needed to complete row
    ///
    /// `byte_number_in_row` - number of byte in row (from where the `bytes` started formatting).
    /// It useful for determining, where to place group separators (if your formatter uses it)
    fn format_padding<O: Write>(&self, byte_number_in_row: usize, out: &mut O) -> Result<()>;

    fn separators(&self) -> &Separators;
}

/// Used for printable ASCII characters formatting
pub trait CharFormatting {
    fn format<O: Write>(&self, bytes: &[u8], out: &mut O) -> Result<usize>;
    fn format_padding<O: Write>(&self, byte_count: usize, out: &mut O) -> Result<()>;

    fn separators(&self) -> &Separators;
}

/// Column separators, used by [crate::Printer]
#[derive(Clone)]
pub struct Separators {
    pub(crate) trailing: Vec<u8>,
    pub(crate) leading: Vec<u8>,
}

impl Separators {
    pub fn new(trailing: &str, leaidng: &str) -> Self {
        Self {
            leading: Vec::from(leaidng),
            trailing: Vec::from(trailing),
        }
    }
}

impl Default for Separators {
    fn default() -> Self {
        Self {
            leading: Vec::from(" "),
            trailing: Default::default(),
        }
    }
}