Struct WithSidebands

pub struct WithSidebands<'a, T, F>
where
    T: Read,
{ /* private fields */ }

Available on crate feature blocking-io and (crate features blocking-io or async-io) only.

An implementor of BufRead yielding packet lines on each call to read_line(). It’s also possible to hide the underlying packet lines using the Read implementation which is useful if they represent binary data, like the one of a pack file.

Implementations

impl<'a, T> WithSidebands<'a, T, fn(bool, &[u8])>

where T: Read,

pub fn new(parent: &'a mut StreamingPeekableIter<T>) -> Self

Create a new instance with the given provider as parent.

impl<'a, T, F> WithSidebands<'a, T, F>

where T: Read, F: FnMut(bool, &[u8]),

pub fn with_progress_handler( parent: &'a mut StreamingPeekableIter<T>, handle_progress: F, ) -> Self

Create a new instance with the given parent provider and the handle_progress function.

Progress or error information will be passed to the given handle_progress(is_error, text) function, with is_error: bool being true in case the text is to be interpreted as error.

pub fn without_progress_handler( parent: &'a mut StreamingPeekableIter<T>, ) -> Self

Create a new instance without a progress handler.

pub fn reset_with(&mut self, delimiters: &'static [PacketLineRef<'static>])

Forwards to the parent StreamingPeekableIter::reset_with()

pub fn stopped_at(&self) -> Option<PacketLineRef<'static>>

Forwards to the parent StreamingPeekableIter::stopped_at()

pub fn set_progress_handler(&mut self, handle_progress: Option<F>)

Set or unset the progress handler.

pub fn peek_data_line(&mut self) -> Option<Result<Result<&[u8], Error>>>

Effectively forwards to the parent StreamingPeekableIter::peek_line(), allowing to see what would be returned next on a call to read_line().

Warning

This skips all sideband handling and may return an unprocessed line with sidebands still contained in it.

pub fn read_data_line( &mut self, ) -> Option<Result<Result<PacketLineRef<'_>, Error>>>

Read a whole packetline from the underlying reader, with empty lines indicating a stop packetline.

Warning

This skips all sideband handling and may return an unprocessed line with sidebands still contained in it.

Trait Implementations

impl<'a, T, F> BufRead for WithSidebands<'a, T, F>

where T: Read, F: FnMut(bool, &[u8]),

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

fn consume(&mut self, amt: usize)

Marks the given amount of additional bytes from the internal buffer as having been read. Subsequent calls to read only return bytes that have not been marked as read.

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

Reads all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn has_data_left(&mut self) -> Result<bool, Error>

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

Checks if there is any data left to be read.

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

Reads all bytes into buf until the delimiter byte or EOF is reached.

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

fn split(self, byte: u8) -> Split<Self>

where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

where Self: Sized,

Returns an iterator over the lines of this reader.

impl<'a, T, F> Drop for WithSidebands<'a, T, F>

where T: Read,

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T, F> Read for WithSidebands<'a, T, F>

where T: Read, F: FnMut(bool, &[u8]),

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.