#string #bom #utf-8 #str #strip

strip_bom

Add a simple BOM striping feature for str and String

1 stable release

1.0.0 Sep 10, 2020

#1674 in Encoding

Download history 2609/week @ 2023-12-06 2008/week @ 2023-12-13 707/week @ 2023-12-20 363/week @ 2023-12-27 1579/week @ 2024-01-03 1575/week @ 2024-01-10 1837/week @ 2024-01-17 1491/week @ 2024-01-24 1421/week @ 2024-01-31 1436/week @ 2024-02-07 2192/week @ 2024-02-14 2309/week @ 2024-02-21 1857/week @ 2024-02-28 1172/week @ 2024-03-06 1167/week @ 2024-03-13 1030/week @ 2024-03-20

5,581 downloads per month
Used in 2 crates

MIT license

4KB

strip_bom

Add a simple BOM striping feature for str and String.

Usage

use str_strip_bom::*;
// Or std::fs::read_to_string, surf::get, ...
let my_string: Vec<u8> = vec![ 0xefu8, 0xbb, 0xbf, 0xf0, 0x9f, 0x8d, 0xa3 ];
let my_string: String  = String::from_utf8( my_string ).unwrap();

// In this time, my_string has the BOM => true ๐Ÿฃ
println!( "{} {}", my_string.starts_with("\u{feff}"), &my_string );

// Strip BOM
let my_string: &str = my_string.strip_bom();

// my_string (slice) has not the BOM => false ๐Ÿฃ
println!( "{} {}", my_string.starts_with("\u{feff}"), &my_string );

Motivation

  1. I author wanted a simple and lightweight BOM stripper for only str and String, not for byte stream or the other of UTF-8 such as UTF-16 or UTF-32.
  2. Because, for example, serde and serde_json has no BOM supporting then it will be fail if I put a UTF-8 BOM source.
  3. The rust standard, str and Strings will not support a BOM stripping features.; See also https://github.com/rust-lang/rfcs/issues/2428.

Reference

License

Author

No runtime deps