reading_liner/lib.rs
1//! This crate is for Reading and converting offset and line-column location while reading butes.
2//!
3//! This crate supports a [Stream] reader which can convert between byte offset and line-column numbers.
4//! Support any type which implements [std::io::Read].
5//!
6//! The whole design is based on an [Index],
7//! which is composed of line information to convert between byte offsets and line-column locations.
8//! One perticular usage is to use the [Stream] as a builder of [Index] or
9//! you can also use it when lazily reading and convert locations at the same time.
10//!
11//! This lib should be used at *low-level abstraction*.
12//! For detailed examples, please refer to
13//! [README](https://github.com/ireina7/reading-liner/blob/main/README.md)
14
15pub mod index;
16pub mod location;
17pub mod stream;
18
19pub use index::{Index, Query};
20pub use stream::Stream;