bytelines 2.5.0

Read input lines as byte slices for high efficiency
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

//! `Bytelines` is a simple library crate which offers line iteration for
//! `BufRead` via `&[u8]` rather than `String`.
//!
//! Due to the removal of checking for `String` validity, this is typically
//! much faster for reading in raw data and much more flexible. The APIs
//! offered in this crate are intended to function exactly the same as the
//! `lines` function inside the `BufRead` trait, except that the bytes which
//! precede the line delimiter are not validated.
//!
//! Performance of [ByteLines](enum.ByteLines.html) is practically identical
//! to that of writing a `loop` manually, due to the avoidance of allocations.
#![doc(html_root_url = "https://docs.rs/bytelines/2.5.0")]
use ::std::io::BufRead;

#[cfg(feature = "tokio")]
use ::tokio::io::AsyncBufRead;

// mods
mod std;
mod util;

#[cfg(feature = "tokio")]
mod tokio;

// expose all public APIs to keep the v2.x interface the same
pub use crate::std::{ByteLines, ByteLinesIter, ByteLinesReader};

#[cfg(feature = "tokio")]
pub use crate::tokio::AsyncByteLines;

/// Creates a new line reader from a stdlib `BufRead`.
#[inline]
pub fn from_std<B>(reader: B) -> ByteLines<B>
where
    B: BufRead,
{
    ByteLines::new(reader)
}

/// Creates a new line reader from a Tokio `AsyncBufRead`.
#[cfg(feature = "tokio")]
#[inline]
pub fn from_tokio<B>(reader: B) -> AsyncByteLines<B>
where
    B: AsyncBufRead + Unpin,
{
    AsyncByteLines::new(reader)
}