Crate eolify 

eolify

High-performance line ending normalization for Rust

eolify is a lightweight, allocation-conscious library for normalizing end-of-line (EOL) sequences in large text streams or buffers. It’s designed for high-throughput processing pipelines, data ingestion systems, and cross-platform tooling where consistency and efficiency matter.

Features

• Fast and memory-efficient — optimized for bulk text processing.
• Normalizes EOLs to a consistent format (currently CRLF \r\n).
• Minimal dependencies — ideal for embedding in performance-critical code.
• Handles mixed endings (\n, \r\n, \r) gracefully.
• Supports:
  • Chunk-based API (buffer slices)
  • Synchronous implementations of Read / Write
  • Asynchronous implementations of AsyncRead / AsyncWrite (both futures_io and tokio supported).

Current status

• Normalization to CRLF (\r\n) is implemented.
• Normalization to LF (\n) is implemented.

Usage

Simple string normalization

use eolify::{CRLF, Normalize};

let text = "one\nline\r\ntwo\rthree";
let normalized = CRLF::normalize_str(text);
assert_eq!(normalized, "one\r\nline\r\ntwo\r\nthree");
println!("{}", normalized);

Synchronous I/O reader / writer

use std::fs::File;
use std::io::{BufWriter, Write};
use eolify::{CRLF, ReadExt};

fn normalize_file_sync(input_path: &str, output_path: &str) -> std::io::Result<()> {
    let infile = File::open(input_path)?;
    let mut reader = infile.normalize_newlines(CRLF);

    let outfile = File::create(output_path)?;
    let mut writer = BufWriter::new(outfile);

    std::io::copy(&mut reader, &mut writer)?;
    writer.flush()?;
    Ok(())
}

Why use eolify?

Working with large text files or streams (logs, ingestion pipelines, cross-platform toolchains) often involves inconsistent line endings (LF, CRLF, CR). Instead of ad-hoc .replace() or loading everything into memory, eolify offers a streaming, allocation-conscious approach so you can normalize while reading or writing, without multiple allocations or buffering the entire file.

Getting started

Add to your Cargo.toml:

[dependencies]
eolify = { version = "0.3", features = ["tokio"] }

# Alternatively enable the `futures-io` async wrappers instead of `tokio`:
# eolify = { version = "0.3", features = ["futures-io"] }

Then either call the high-level string routines (for small chunks) or use the I/O wrappers for streaming use-cases.

Asynchronous I/O (Tokio)

Enable the tokio feature (see Cargo snippet above) and use the TokioAsyncReadExt / TokioAsyncWriteExt helpers:

use tokio::fs::File;
use tokio::io::{AsyncWriteExt, BufWriter};
use eolify::{CRLF, TokioAsyncReadExt};

async fn normalize_file_async(input_path: &str, output_path: &str) -> std::io::Result<()> {
  let infile = File::open(input_path).await?;
  let mut reader = infile.normalize_newlines(CRLF);

  let outfile = File::create(output_path).await?;
  let mut writer = BufWriter::new(outfile);

  tokio::io::copy(&mut reader, &mut writer).await?;
  writer.shutdown().await?;
  Ok(())
}

License

MIT or Apache-2.0, at your option.

Upgrade notes (0.3.x → 0.4.0)

If you are upgrading from 0.3.x to 0.4.0 there are API changes you need to address if you used the low-level chunked normalization API:

• The old Normalize chunk trait was refactored into NormalizeChunk and a convenience Normalize impl now exists for whole-buffer operations.
• normalize_chunk now takes an output buffer of MaybeUninit<u8> and an optional state: Option<&Self::State> instead of preceded_by_cr: bool. Implementations should use the associated State type to track any carried state (e.g. whether the previous chunk ended with \r).
• The result type NormalizeChunkResult now returns state() to retrieve the next chunk state (previously ended_with_cr() boolean).
• Use max_output_size_for_chunk(chunk_size, state, is_last_chunk) to allocate output buffers with proper capacity before calling normalize_chunk.

Example migration pattern (pseudo-Rust):

// old (0.3.x)
let mut out = vec![0u8; input.len()];
let status = LF::normalize_chunk(input, &mut out, preceded_by_cr, true)?;

// new (0.4.0)
let mut out = Vec::with_capacity(Self::max_output_size_for_chunk(input.len(), None, true));
let status = LF::normalize_chunk(input, vec_to_uninit_mut(&mut out), None, true)?;
unsafe { out.set_len(status.output_len()); }
let state = status.state();

If you only used the higher-level normalize or normalize_str helpers, no changes are required.

Modules

helpers

Structs

CRLF

CRLF normalization format implementation.

LF

LF normalization format implementation.

NormalizeChunkResult

Result returned by normalize_chunk describing how many bytes were written and whether the chunk ended with a \r.

Enums

Error

Error type for normalize operations.

Traits

FuturesIoAsyncReadExt

Extension trait to provide convenient methods on futures::io::AsyncRead.

FuturesIoAsyncWriteExt

Extension trait to provide convenient methods on futures::io::AsyncWrite.

FuturesIoExt

Extension trait to provide convenient methods on Normalize for futures::io::AsyncRead and futures::io::AsyncWrite.

IoExt

Extension trait to provide convenient methods on Normalize for std::io::Read and std::io::Write.

Normalize

This is the trait that consumers will typically use to normalize vectors or string slices to a specific format.

NormalizeChunk

This is the core trait that defines how to normalize a chunk data to a specific format.

ReadExt

Extension trait to provide convenient methods on std::io::Read.

TokioAsyncReadExt

Extension trait to provide convenient methods on tokio::AsyncRead.

TokioAsyncWriteExt

Extension trait to provide convenient methods on tokio::AsyncWrite.

TokioExt

Extension trait to provide convenient methods on Normalize for tokio::AsyncRead and tokio::AsyncWrite.

WriteExt

Extension trait to provide convenient methods on std::io::Write.

Type Aliases

Result

Result type alias for normalize operations.