Rust Line Endings

OS	Status
Ubuntu-latest
macOS-latest
Windows-latest

A Rust crate to detect, normalize, and convert line endings across platforms. Ensures consistent handling of LF, CRLF, and CR line endings in text processing.

Install

cargo add line-ending

Usage

Split into lines

Split a string into lines using the detected line ending.

use line_ending::LineEnding;

let crlf_lines = LineEnding::split_into_lines("first\r\nsecond\r\nthird");
let cr_lines = LineEnding::split_into_lines("first\rsecond\rthird");
let lf_lines = LineEnding::split_into_lines("first\nsecond\nthird");

let expected = vec!["first", "second", "third"];

assert_eq!(crlf_lines, expected);
assert_eq!(cr_lines, expected);
assert_eq!(lf_lines, expected);

Apply to lines

Join a vector of strings with the specified line ending.

use line_ending::LineEnding;

let lines = vec![
  "first".to_string(),
  "second".to_string(),
  "third".to_string(),
];

assert_eq!(
    LineEnding::CRLF.apply_to_lines(lines.clone()),
    "first\r\nsecond\r\nthird"
);
assert_eq!(
    LineEnding::CR.apply_to_lines(lines.clone()),
    "first\rsecond\rthird"
);
assert_eq!(
    LineEnding::LF.apply_to_lines(lines.clone()),
    "first\nsecond\nthird"
);

Convert to type

Convert a string from any line ending type to a specified one.

use line_ending::LineEnding;

let mixed_text = "first line\r\nsecond line\rthird line\nfourth line\n";

assert_eq!(
    LineEnding::CRLF.convert_to(mixed_text),
    "first line\r\nsecond line\r\nthird line\r\nfourth line\r\n"
);
assert_eq!(
    LineEnding::CR.convert_to(mixed_text),
    "first line\rsecond line\rthird line\rfourth line\r"
);
assert_eq!(
    LineEnding::LF.convert_to(mixed_text),
    "first line\nsecond line\nthird line\nfourth line\n"
);

From string slice

Detect the predominant line ending style used in the input string.

use line_ending::LineEnding;

let sample = "first line\nsecond line\nthird line";
assert_eq!(LineEnding::from(sample), LineEnding::LF);

use line_ending::LineEnding;

let sample = "first line\r\nsecond line\r\nthird line";
assert_eq!(LineEnding::from(sample), LineEnding::CRLF);

use line_ending::LineEnding;

let sample = "first line\rsecond line\rthird line";
assert_eq!(LineEnding::from(sample), LineEnding::CR);

Normalize

Convert all line endings in a string to LF (\n) for consistent processing.

use line_ending::LineEnding;

let crlf = "first\r\nsecond\r\nthird";
let cr = "first\rsecond\rthird";
let lf = "first\nsecond\nthird";

assert_eq!(LineEnding::normalize(crlf), lf);
assert_eq!(LineEnding::normalize(cr), lf);
assert_eq!(LineEnding::normalize(lf), lf);

Denormalize

Restore line endings in a string to the specified type.

use line_ending::LineEnding;

let text = "first\nsecond\nthird";
let crlf_restored = LineEnding::CRLF.denormalize(text);
let cr_restored = LineEnding::CR.denormalize(text);
let lf_restored = LineEnding::LF.denormalize(text);

assert_eq!(crlf_restored, "first\r\nsecond\r\nthird");
assert_eq!(cr_restored, "first\rsecond\rthird");
assert_eq!(lf_restored, "first\nsecond\nthird");

License

Licensed under MIT. See LICENSE for details.

line-ending 1.0.1