Struct Stream

pub struct Stream<Reader> { /* private fields */ }

A stream which can be used to convert between offsets and line-column numbers.

Implementations

impl<R> Stream<R>

pub fn base(&self) -> usize

pub fn line_offset(&self, line: usize) -> Option<Offset>

impl<R: Read> Stream<R>

pub fn new(reader: R, buffer_size: usize) -> Self

pub fn from_reader(reader: R) -> Self

pub fn set_base(&mut self, base: usize)

pub fn reset(&mut self)

pub fn read_len(&self) -> usize

Read length

pub fn offset_of(&mut self, line_index: ZeroBased) -> Result<Offset>

Get offset from line and column number

pub fn line_index(&mut self, offset: Offset) -> Result<ZeroBased>

Get line and column number from offset

pub fn try_line_of(&self, offset: Offset) -> Option<usize>

Try to get line of offset without reading

pub fn try_line_index(&self, offset: Offset) -> Option<ZeroBased>

Try to get line index of offset

pub fn try_offset_of(&mut self, line_index: ZeroBased) -> Option<Offset>

Try to get offset from (line, column)

pub fn line_of(&mut self, offset: Offset) -> Result<usize>

Get line of offset

pub fn read_forward(&mut self) -> Result<(usize, &[u8])>

pub fn read_line_of( &mut self, offset: Offset, buf: &mut Vec<u8>, ) -> Result<usize>

Get line, column of offset while returning read bytes in buf

pub fn read_line_index( &mut self, offset: Offset, buf: &mut Vec<u8>, ) -> Result<ZeroBased>

Get line, column index while returning read bytes in buf

pub fn read_offset_of( &mut self, line_index: ZeroBased, buf: &mut Vec<u8>, ) -> Result<Offset>

Get offset from line-column index while returning read bytes in buf

pub fn drain(&mut self) -> Result<()>

Drain the reader, consume the reader

Trait Implementations

impl<Reader: Debug> Debug for Stream<Reader>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R: Read> From<R> for Stream<R>

fn from(value: R) -> Self

Converts to this type from the input type.

impl<R: Read> Read for Stream<R>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.