Struct git_packetline::provider::ReadWithSidebands

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

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.

Performance Notice

Reading from this intermediary copies bytes 3 times: OS -> (parent) line provider buffer -> our buffer -> caller's output buffer which won't make this very efficient for huge bandwidths.

Implementations

impl<'a, T> ReadWithSidebands<'a, T, fn(_: bool, _: &[u8])> where
    T: Read, 

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

impl<'a, T, F> ReadWithSidebands<'a, T, F> where
    T: Read,
    F: FnMut(bool, &[u8]), 

pub fn with_progress_handler(
    parent: &'a mut Provider<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 Provider<T>) -> Self

Create a new instance without a progress handler.

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

Forwards to the parent Provider::reset_with()

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

Forwards to the parent Provider::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 Provider::peek_line(), allowing to see what would be returned next on a call to read_line().

Trait Implementations

impl<'a, T, F> BufRead for ReadWithSidebands<'a, T, F> where
    T: Read,
    F: FnMut(bool, &[u8]), 

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

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

pub fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

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

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

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

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

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

pub fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<'a, T, F> Drop for ReadWithSidebands<'a, T, F> where
    T: Read, 

pub fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T, F> Read for ReadWithSidebands<'a, T, F> where
    T: Read,
    F: FnMut(bool, &[u8]), 

pub 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.

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

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

pub 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.

pub unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

pub fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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