#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

#1969 in Encoding

Download history 1051/week @ 2024-03-14 1627/week @ 2024-03-21 3178/week @ 2024-03-28 2456/week @ 2024-04-04 2103/week @ 2024-04-11 2393/week @ 2024-04-18 2760/week @ 2024-04-25 1591/week @ 2024-05-02 2129/week @ 2024-05-09 1829/week @ 2024-05-16 3266/week @ 2024-05-23 4078/week @ 2024-05-30 2498/week @ 2024-06-06 2246/week @ 2024-06-13 2576/week @ 2024-06-20 3799/week @ 2024-06-27

11,540 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