Enum gix_filter::pipeline::convert::ToGitOutcome

pub enum ToGitOutcome<'pipeline, R> {
    Unchanged(R),
    Process(Box<dyn Read + 'pipeline>),
    Buffer(&'pipeline [u8]),
}

The result of a conversion with zero or more filters to be stored in git.

Variants

Unchanged(R)

The original input wasn’t changed and the reader is still available for consumption.

Process(Box<dyn Read + 'pipeline>)

An external filter (and only that) was applied and its results have to be consumed.

Buffer(&'pipeline [u8])

A reference to the result of one or more filters of which one didn’t support streaming.

This can happen if an eol, working-tree-encoding or ident filter is applied, possibly on top of an external filter.

Implementations

impl<'a, R> ToGitOutcome<'a, R>

where R: Read,

pub fn as_bytes(&self) -> Option<&'a [u8]>

If we contain a buffer, and not a stream, return it.

pub fn as_read(&mut self) -> Option<&mut (dyn Read + '_)>

Return a stream to read the drivers output from. This is only possible if there is only a driver, and no other filter.

pub fn is_changed(&self) -> bool

Returns true if the input buffer was actually changed, or false if it is returned directly.

Trait Implementations

impl<'pipeline, R> Read for ToGitOutcome<'pipeline, R>

where R: Read,

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.