https://github.com/wolandr/pretty-hex

A Rust library providing pretty hex dump.
https://github.com/wolandr/pretty-hex

hexdump rust zero-dependency

Last synced: about 2 months ago
JSON representation

A Rust library providing pretty hex dump.

• Host: GitHub
• URL: https://github.com/wolandr/pretty-hex
• Owner: wolandr
• License: mit
• Created: 2018-03-08T17:53:33.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-21T06:50:59.000Z (9 months ago)
• Last Synced: 2024-04-23T21:37:28.017Z (5 months ago)
• Topics: hexdump, rust, zero-dependency
• Language: Rust
• Homepage:
• Size: 36.1 KB
• Stars: 49
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pretty-hex

[![crates.io](https://img.shields.io/crates/v/pretty-hex.svg)](https://crates.io/crates/pretty-hex) 

[![docs.rs](https://docs.rs/pretty-hex/badge.svg)](https://docs.rs/pretty-hex)

A Rust library providing pretty hex dump.

A `simple_hex()` way renders one-line hex dump, a `pretty_hex()` way renders 

columned multi-line hex dump with addressing and ASCII representation.

A `config_hex()` way renders hex dump in specified format.

## Example of `simple_hex()`

```rust

use pretty_hex::*;

let v = vec![222, 173, 190, 239, 202, 254, 32, 24];

assert_eq!(simple_hex(&v), format!("{}", v.hex_dump()));

println!("{}", v.hex_dump());

```

Output: 

```text

de ad be ef  ca fe 20 18

```

## Example of `pretty_hex()`

```rust

use pretty_hex::*;

let v: &[u8] = &random::<[u8;30]>();

assert_eq!(pretty_hex(&v), format!("{:?}", v.hex_dump()));

println!("{:?}", v.hex_dump());

```

Output: 

```text

Length: 30 (0x1e) bytes

0000:   6b 4e 1a c3  af 03 d2 1e  7e 73 ba c8  bd 84 0f 83   kN......~s......

0010:   89 d5 cf 90  23 67 4b 48  db b1 bc 35  bf ee         ....#gKH...5..

```

## Example of `config_hex()`

```rust

use pretty_hex::*;

let cfg = HexConfig {title: false, width: 8, group: 0, ..HexConfig::default() };

let v = &include_bytes!("data");

assert_eq!(config_hex(&v, cfg), format!("{:?}", v.hex_conf(cfg)));

println!("{:?}", v.hex_conf(cfg));

```

Output:

```text

0000:   6b 4e 1a c3 af 03 d2 1e   kN......

0008:   7e 73 ba c8 bd 84 0f 83   ~s......

0010:   89 d5 cf 90 23 67 4b 48   ....#gKH

0018:   db b1 bc 35 bf ee         ...5..

```

---

Inspired by [haskell's pretty-hex](https://hackage.haskell.org/package/pretty-hex-1.0).