newline-converter

Crates.ionewline-converter
lib.rsnewline-converter
version0.3.0
sourcesrc
created_at2020-06-07 08:46:32.071489
updated_at2023-03-23 22:53:09.955923
descriptionNewline byte converter library
homepage
repositoryhttps://github.com/spitfire05/rnc/tree/master/crates/newline-converter
max_upload_size
id250908
size16,390
Michał Borejszo (spitfire05)

documentation

README

newline-converter

newline-converter is a simple library used for converting the newline characters in strings between Windows \r\n and Unix \n style. It mainly serves as a backend for Rust Newline converter CLI tool.

Crates.io

Comparision of newline-wrangling methods

newline-converter (this crate)

  • ✅ Properly handles edge-cases like lone \r characters. For example, \r\n sequences won't become \r\r\n after unix2dos call:
    use newline_converter::unix2dos;
    assert_eq!(
      unix2dos("\nfoo\r\nbar\n"),
      "\r\nfoo\rbar\n"
    );
    
  • ✅ Is the fastest when input data is small (few bytes of text with line breaks).
  • ❌ Is the slowest (or second slowest in case of unix2dos) when dealing with larger data sets (ex. 100 paragraphs of Lorem Ipsum).

string.replace

  • ❌ Does not handle edge cases properly in unix2dos.
  • ✅ Good performance on larger data sets.

regex crate Regex::replace_all

  • ❌ Does not handle edge cases properly in unix2dos, because of lack of support for look around.
  • ✅ The best performance with larger data sets.

fancy-regex crate Regex::replace_all

  • ✅ Properly handles edge cases.
  • unix2dos has worst performance of all implementations, by an order of magnitude (because of look around used).

Look into benches/bench.rs for the comparision benchmarks.

MSRV

Minimum Supported Rust Version is 1.38.0.

Commit count: 98

cargo fmt