Struct gix_worktree_stream::Entry

pub struct Entry<'a> {
    pub mode: EntryMode,
    pub id: ObjectId,
    /* private fields */
}

An entry in a stream. Note that they must be consumed fully, by reading from them till exhaustion.

Drop behaviour

If the entry is dropped without reading it till exhaustion, the stream is tainted and next_entry() will panic next time it is called.

Fields

mode: EntryMode

The kind of entry at relative_path.

id: ObjectId

The hash of the object, uniquely identifying it.

Implementations

impl Entry<'_>

pub fn relative_path(&self) -> &BStr

Return the path of this entry as slash-separated path relative to the repository.

pub fn bytes_remaining(&self) -> Option<usize>

The amount of bytes that remain to be read, or None if it’s fully streamed.

This equals the length of the entry in bytes right before reading it.

Trait Implementations

impl Debug for Entry<'_>

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

Formats the value using the given formatter.

impl<'a> Drop for Entry<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl Read for Entry<'_>

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>

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

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

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

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

Read 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)

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