hexout 0.1.0

A compact and dependency-free, flexible and customizable hex dump library for Rust that provides beautiful, configurable binary data visualization.
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
use super::*;

#[test]
fn simple_test() {
    let data = vec![0u8, 1, 2, 3, 4, 5, 6, 7, 8, 9];
    let result = hex_out(&data, &HexOutSettings::default(), 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 00 01 02 03 04 05 06 07  08 09                   |........ ..      |");
}

#[test]
fn no_ascii() {
    let data = vec![0u8, 1, 2, 3, 4, 5, 6, 7, 8, 9];
    let settings = HexOutSettings {
        show_ascii: false,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 00 01 02 03 04 05 06 07  08 09");
}

#[test]
fn with_16bit_groups() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 2,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 2).unwrap();
    assert_eq!(result, "00000000: 0100 0302 0504 0706  0908 0b0a 0d0c 0f0e |........ ........|\n00000010: 1110 1312 1514 1716  1918 1b1a 1d1c 1f1e |........ ........|");
}

#[test]
fn with_32bit_groups() {
    let data = (0u8..=63).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 4,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 2).unwrap();
    assert_eq!(result, "00000000: 03020100 07060504 0b0a0908 0f0e0d0c  13121110 17161514 1b1a1918 1f1e1d1c |................ ................|\n00000020: 23222120 27262524 2b2a2928 2f2e2d2c  33323130 37363534 3b3a3938 3f3e3d3c | !\"#$%&'()*+,-./ 0123456789:;<=>?|");
}

#[test]
fn single_line() {
    let data = (0u8..=47).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 1,
        groups_per_line: 16,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 1, 1).unwrap();
    assert_eq!(result, "00000010: 10 11 12 13 14 15 16 17  18 19 1a 1b 1c 1d 1e 1f |........ ........|");
}

#[test]
fn just_words() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        show_ascii: false,
        show_offset: false,
        group_size: 2,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 2).unwrap();
    assert_eq!(result, "0100 0302 0504 0706  0908 0b0a 0d0c 0f0e\n1110 1312 1514 1716  1918 1b1a 1d1c 1f1e");
}

#[test]
fn simple_uppercase() {
    let data = (0u8..=15u8).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        uppercase: true,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 00 01 02 03 04 05 06 07  08 09 0A 0B 0C 0D 0E 0F |........ ........|");
}

#[test]
fn simple_no_centerline() {
    let data = (0u8..=15u8).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        show_centerline: false,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 00 01 02 03 04 05 06 07 08 09 0a 0b 0c 0d 0e 0f |................|");
}

#[test]
fn with_32bit_partial_line() {
    let data = (0u8..=0x34).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 4,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 2).unwrap();
    assert_eq!(result, "00000000: 03020100 07060504 0b0a0908 0f0e0d0c  13121110 17161514 1b1a1918 1f1e1d1c |................ ................|\n00000020: 23222120 27262524 2b2a2928 2f2e2d2c  33323130 ??????34                   | !\"#$%&'()*+,-./ 01234           |");
}

#[test]
fn with_32bit_partial_line_uppercase() {
    let data = (0u8..=0x34).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 4,
        groups_per_line: 8,
        uppercase: true,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 2).unwrap();
    assert_eq!(result, "00000000: 03020100 07060504 0B0A0908 0F0E0D0C  13121110 17161514 1B1A1918 1F1E1D1C |................ ................|\n00000020: 23222120 27262524 2B2A2928 2F2E2D2C  33323130 ??????34                   | !\"#$%&'()*+,-./ 01234           |");
}

#[test]
fn reversed_data() {
    let data = (32u8..=47u8).rev().collect::<Vec<u8>>();
    let settings = HexOutSettings {
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 2f 2e 2d 2c 2b 2a 29 28  27 26 25 24 23 22 21 20 |/.-,+*)( '&%$#\"! |");
}

#[test]
fn big_endian_16bit() {
    let data = (0u8..=15u8).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 2,
        groups_per_line: 8,
        big_endian: true,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 0001 0203 0405 0607  0809 0a0b 0c0d 0e0f |........ ........|");
}

#[test]
fn big_endian_16bit_incomplete() {
    let data = (0u8..=14u8).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 2,
        groups_per_line: 8,
        big_endian: true,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 0001 0203 0405 0607  0809 0a0b 0c0d 0e?? |........ ....... |");
}

#[test]
fn simple_32bit_incomplete_leading_zeros() {
    let data = vec![0u8, 1, 2, 3, 4];
    let settings = HexOutSettings {
        group_size: 4,
        groups_per_line: 4,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert_eq!(result, "00000000: 03020100 ??????04                    |.....            |");
}

#[test]
fn simple_trait_usage() {
    let data = vec![0u8, 1, 2, 3, 4, 5, 6, 7, 8, 9];
    let result = &data.as_slice().hex_out().unwrap();
    assert_eq!(result, "00000000: 00 01 02 03 04 05 06 07  08 09                   |........ ..      |");
}

#[test]
fn simple_trait_usage_with_lines() {
    let data = vec![0u8, 1, 2, 3, 4, 5, 6, 7, 8, 9];
    let result = &data.as_slice().hex_out_lines(0, 1).unwrap();
    assert_eq!(result, "00000000: 00 01 02 03 04 05 06 07  08 09                   |........ ..      |");
}

#[test]
fn simple_trait_usage_with_settings() {
    let data = vec![0u8, 1, 2, 3, 4, 5, 6, 7, 8, 9];
    let settings = HexOutSettings {
        group_size: 2,
        groups_per_line: 8,
        show_ascii: false,
        ..Default::default()
    };
    let result = &data.as_slice().hex_out_with_settings(settings).unwrap();
    assert_eq!(result, "00000000: 0100 0302 0504 0706  0908");
}

#[test]
fn with_24bits() {
    let data = (32u8..=67).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 3,
        groups_per_line: 4,
        ..Default::default()
    };
    let result = data.as_slice().hex_out_lines_with_settings(settings, 0, 0).unwrap();
    assert_eq!(result, "00000000: 222120 252423  282726 2b2a29 | !\"#$% &'()*+|\n0000000c: 2e2d2c 31302f  343332 373635 |,-./01 234567|\n00000018: 3a3938 3d3c3b  403f3e 434241 |89:;<= >?@ABC|");
}

#[test]
fn lines_past_end() {
    let data = (0u8..=7).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 1,
        groups_per_line: 4,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 5, 2).unwrap();
    assert_eq!(result, "");
}

#[test]
fn missing_data_with_32bits() {
    let data = (0u8..=7).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 4,
        groups_per_line: 2,
        ..Default::default()
    };
    let result = data.as_slice().hex_out_with_settings(settings).unwrap();
    assert_eq!(result, "00000000: 03020100  07060504 |.... ....|");
}

#[test]
fn with_4digit_address() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        address_width: 4,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 0).unwrap();
    assert_eq!(result, "0000: 00 01 02 03  04 05 06 07 |.... ....|\n0008: 08 09 0a 0b  0c 0d 0e 0f |.... ....|\n0010: 10 11 12 13  14 15 16 17 |.... ....|\n0018: 18 19 1a 1b  1c 1d 1e 1f |.... ....|");
}

#[test]
fn offset_address() {
    let data = (0u8..=32).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        address_width: 4,
        align_address: false,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 3, 0, 0).unwrap();
    assert_eq!(result, "0003: 03 04 05 06  07 08 09 0a |.... ....|\n000b: 0b 0c 0d 0e  0f 10 11 12 |.... ....|\n0013: 13 14 15 16  17 18 19 1a |.... ....|\n001b: 1b 1c 1d 1e  1f 20       |.... .   |");
}

#[test]
fn offset_address_aligned() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        address_width: 4,
        align_address: true,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 3, 0, 0).unwrap();
    assert_eq!(result, "0000:          03  04 05 06 07 |   . ....|\n0008: 08 09 0a 0b  0c 0d 0e 0f |.... ....|\n0010: 10 11 12 13  14 15 16 17 |.... ....|\n0018: 18 19 1a 1b  1c 1d 1e 1f |.... ....|");
}

#[test]
fn offset_address_aligned_32bit() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        address_width: 2,
        align_address: true,
        group_size: 4,
        groups_per_line: 4,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 3, 0, 0).unwrap();
    assert_eq!(result, "00: 03?????? 07060504  0b0a0908 0f0e0d0c |   ..... ........|\n10: 13121110 17161514  1b1a1918 1f1e1d1c |........ ........|");
}

#[test]
fn offset_address_aligned_32bit_big_endian() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        address_width: 2,
        align_address: true,
        group_size: 4,
        groups_per_line: 4,
        big_endian: true, 
        uppercase: true,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 3, 0, 0).unwrap();
    assert_eq!(result, "00: ??????03 04050607  08090A0B 0C0D0E0F |   ..... ........|\n10: 10111213 14151617  18191A1B 1C1D1E1F |........ ........|");
}

#[test]
fn ensure_error_on_invalid_group_size() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        group_size: 0,
        groups_per_line: 8,
        ..Default::default()
    };
    let result= hex_out(&data, &settings, 0, 0, 0);
    assert!(result.is_err());
    assert!(matches!(result.err().unwrap(), HexOutError::InvalidGroupSize));

    let settings = HexOutSettings {
        group_size: 17,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 0);
    assert!(result.is_err());
    assert_eq!(format!("{:?}", result.as_ref()), "Err(HexOutError::InvalidGroupSize)".to_string());
    assert_eq!(format!("{}", result.as_ref().err().unwrap()), "Invalid group size (must be 1-16)".to_string());
}

#[test]
fn offset_address_aligned_32bit_strict() {
    let data = (0u8..=31).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        address_width: 2,
        align_address: true,
        group_size: 4,
        groups_per_line: 4,
        strict: true,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 3, 0, 0);
    assert!(result.is_err());
    assert_eq!(format!("{:?}", result.as_ref()), "Err(HexOutError::UnalignedOffset { offset: 3, group_size: 4 })".to_string());
    assert_eq!(format!("{}", result.as_ref().err().unwrap()), "Offset 3 does not align with group size 4 in strict mode (offset % group_size = 3)".to_string());
}

#[test]
fn ansi_colored_errors() {
    let data = (0u8..=30).collect::<Vec<u8>>();
    let settings = HexOutSettings {
        hex_out_error_prefix: Some("\x1b[31m".to_string()),
        hex_out_error_postfix: Some("\x1b[0m".to_string()),
        group_size: 2,
        groups_per_line: 8,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 0).unwrap();
    assert_eq!(result, "00000000: 0100 0302 0504 0706  0908 0b0a 0d0c 0f0e |........ ........|\n00000010: 1110 1312 1514 1716  1918 1b1a 1d1c \x1b[31m??\x1b[0m1e |........ ....... |");
}




#[test]
fn large_line_count_doesnt_hang() {
    let data = vec![0u8; 10];
    let settings = HexOutSettings::default();
    // Request way more lines than data available
    let result = hex_out(&data, &settings, 0, 0, 1000);
    assert!(result.is_ok());
}

#[test]
fn empty_data() {
    let data = vec![];
    let result = hex_out(&data, &HexOutSettings::default(), 0, 0, 0).unwrap();
    assert_eq!(result, "");
}

#[test]
fn single_byte() {
    let data = vec![0x42];
    let settings = HexOutSettings::default();
    let result = hex_out(&data, &settings, 0, 0, 1).unwrap();
    assert!(result.contains("42"));
}

#[test]
fn unaligned_offset_strict_mode_should_error() {
    let data = vec![0u8; 10];
    let settings = HexOutSettings {
        strict: true,
        group_size: 4,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 1, 0, 1); // offset 1 not aligned to group_size 4
    assert!(matches!(result, Err(HexOutError::UnalignedOffset { offset: 1, group_size: 4 })));
}

#[test]
fn zero_group_size_should_error() {
    let data = vec![0u8; 10];
    let settings = HexOutSettings {
        group_size: 0,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1);
    assert!(matches!(result, Err(HexOutError::InvalidGroupSize)));
}

#[test]
fn group_size_too_large_should_error() {
    let data = vec![0u8; 10];
    let settings = HexOutSettings {
        group_size: 17,
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0, 0, 1);
    assert!(matches!(result, Err(HexOutError::InvalidGroupSize)));
}

#[test]
fn align_address_with_offset_should_pad() {
    let data = vec![0xAAu8; 32];
    let settings = HexOutSettings {
        align_address: true,
        group_size: 4,
        groups_per_line: 4,
        ..Default::default()
    };
    // Start at offset 8 (should align to 0 and pad first 8 bytes)
    let result = hex_out(&data, &settings, 8, 0, 1).unwrap();
    // Should show address 00000000 with padding for first 8 bytes
    assert!(result.starts_with("00000000:"));
    // Should have spaces for the first 2 groups
    // This is the behavior your code SHOULD have but may not currently implement
}

#[test]
fn extremely_large_offset() {
    let data = vec![0u8; 10];
    let settings = HexOutSettings {
        address_width: 16, // 64-bit addresses
        ..Default::default()
    };
    let result = hex_out(&data, &settings, 0xFFFF_FFFF_0000_0000, 0, 1);
    // Should handle gracefully, not panic
    assert!(result.is_ok());
}