hexxdump 1.1.1

A simple, configurable tool for generating hex dumps
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

use crate::Hexxdump;

/// The default configuration for [`hexxdump::DEFAULT`](`crate::DEFAULT`)
pub const DEFAULT: Config = Config {
	bytes_per_row: 16,
	address_width: 4,
	show_address: true,
	show_hex_values: true,
	show_characters: true,
	use_control_pictures: false,
	substitute_character: '.',
};

/// Configures a [`Hexxdump`]'s output
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct Config {
	pub(super) bytes_per_row: usize,
	pub(super) address_width: usize,
	pub(super) show_address: bool,
	pub(super) show_hex_values: bool,
	pub(super) show_characters: bool,
	pub(super) use_control_pictures: bool,
	pub(super) substitute_character: char,
}

impl Config {
	/// Creates a new, default configuration (equivalent to [`DEFAULT`])
	pub const fn new() -> Self { DEFAULT }

	/// Builds a [`Hexxdump`] with this configuration
	///
	/// Equivalent to calling [`Hexxdump::with_config`]`(self)`
	pub const fn into_hexxdump(self) -> Hexxdump { Hexxdump::with_config(self) }

	/// Sets the number of bytes to output per row
	pub const fn bytes_per_row(mut self, bytes_per_row: usize) -> Self {
		self.bytes_per_row = bytes_per_row;
		self
	}

	/// Sets the width (in hex digits) to use for the address
	///
	/// Note: If a dump requires more digits, they will be rounded up to a multiple of two
	pub const fn address_width(mut self, address_width: usize) -> Self {
		self.address_width = address_width;
		self
	}

	/// Sets whether the address (left) column is included in dumps
	pub const fn show_address(mut self, show: bool) -> Self {
		self.show_address = show;
		self
	}

	/// Sets whether the hex values (middle) column is included in dumps
	pub const fn show_hex_values(mut self, show: bool) -> Self {
		self.show_hex_values = show;
		self
	}

	/// Sets whether the characters (right) column is included in dumps
	pub const fn show_characters(mut self, show: bool) -> Self {
		self.show_characters = show;
		self
	}

	/// Sets whether ASCII control characters (0 ~ 31) are printed using Unicode characters from the "Control Pictures" block or the [substitute character](Self::substitute_character)
	pub const fn use_control_pictures(mut self, use_cp: bool) -> Self {
		self.use_control_pictures = use_cp;
		self
	}

	/// Sets the substitute character, the character printed to represent non-ASCII-printable bytes
	///
	/// The substitute character will be printed for non-ASCII (80 ~ 255) bytes.
	/// It will also be printed for ASCII control characters (0 ~ 31) if [`use_control_pictures`](Self::use_control_pictures) is set to `false`.
	///
	/// Defaults to `.`
	pub const fn substitute_character(mut self, substitute_character: char) -> Self {
		self.substitute_character = substitute_character;
		self
	}
}

impl Default for Config {
	fn default() -> Self { Self::new() }
}