#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

#1021 in Text processing

Download history 3013/week @ 2024-11-16 2855/week @ 2024-11-23 3687/week @ 2024-11-30 3416/week @ 2024-12-07 4515/week @ 2024-12-14 995/week @ 2024-12-21 1061/week @ 2024-12-28 2846/week @ 2025-01-04 3055/week @ 2025-01-11 3119/week @ 2025-01-18 2907/week @ 2025-01-25 2874/week @ 2025-02-01 3352/week @ 2025-02-08 2941/week @ 2025-02-15 3203/week @ 2025-02-22 3045/week @ 2025-03-01

13,005 downloads per month
Used in 95 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