#byte-sequences #escaping #ascii #characters #printable #forms #utf-8

no-std escape-bytes

Escapes bytes that are not printable ASCII characters

2 releases

0.1.1 Dec 1, 2023
0.1.0 Dec 1, 2023
0.0.1 Nov 30, 2023

#1589 in Text processing

Download history 2240/week @ 2024-10-15 2111/week @ 2024-10-22 2736/week @ 2024-10-29 3127/week @ 2024-11-05 3463/week @ 2024-11-12 3185/week @ 2024-11-19 2857/week @ 2024-11-26 3371/week @ 2024-12-03 3936/week @ 2024-12-10 3772/week @ 2024-12-17 668/week @ 2024-12-24 1685/week @ 2024-12-31 2863/week @ 2025-01-07 2953/week @ 2025-01-14 3348/week @ 2025-01-21 2275/week @ 2025-01-28

11,922 downloads per month
Used in 94 crates (4 directly)

Apache-2.0

50KB
987 lines

escape-bytes

Escapes bytes that are not printable ASCII characters.

The exact rules are:

  • Nul is escaped as \0.
  • Tab is escaped as \t.
  • Line feed is escaped as \n.
  • Carriage return is escaed as \r.
  • Backslach is escaped as \\.
  • Any character in the printable ASCII range 0x20..=0x7e is not escaped.
  • Any other character is hex escaped in the form \xNN.

Intended for use where byte sequences are not valid ASCII or UTF-8 but need to be stored in a semi-human readable form where only ASCII or UTF-8 are permitted.

Examples

Escape

let str = b"hello\xc3world";
let escaped = escape_bytes::escape(str);
assert_eq!(escaped, br"hello\xc3world");

Unescape

let escaped = br"hello\xc3world";
let unescaped = escape_bytes::unescape(escaped)?;
assert_eq!(unescaped, b"hello\xc3world");

License: Apache-2.0


lib.rs:

Escapes bytes that are not printable ASCII characters.

The exact rules are:

  • Nul is escaped as \0.
  • Tab is escaped as \t.
  • Line feed is escaped as \n.
  • Carriage return is escaed as \r.
  • Backslach is escaped as \\.
  • Any character in the printable ASCII range 0x20..=0x7e is not escaped.
  • Any other character is hex escaped in the form \xNN.

Intended for use where byte sequences are not valid ASCII or UTF-8 but need to be stored in a semi-human readable form where only ASCII or UTF-8 are permitted.

Examples

Escape

let str = b"hello\xc3world";
let escaped = escape_bytes::escape(str);
assert_eq!(escaped, br"hello\xc3world");

Unescape

let escaped = br"hello\xc3world";
let unescaped = escape_bytes::unescape(escaped)?;
assert_eq!(unescaped, b"hello\xc3world");

No runtime deps

Features