Struct okaywal::EntryChunk

pub struct EntryChunk<'chunk, 'entry, F>where
    F: File,{ /* private fields */ }

A chunk of data previously written using EntryWriter::write_chunk.

Panics

Once dropped, this type will ensure that the entry reader is advanced to the end of this chunk if needed by calling EntryChunk::skip_remaining_bytes(). If an error occurs during this call, a panic will occur.

To prevent all possibilities of panics, all bytes should be exhausted before dropping this type by:

• Using Read until a 0 is returned.
• Using EntryChunk::read_all() to read all remaining bytes at once.
• Skipping all remaining bytes using EntryChunk::skip_remaining_bytes()

Implementations

impl<'chunk, 'entry, F> EntryChunk<'chunk, 'entry, F>where F: File,

pub fn log_position(&self) -> LogPosition

Returns the position that this chunk is located at.

pub const fn bytes_remaining(&self) -> u32

Returns the number of bytes remaining to read from this chunk.

pub fn check_crc(&mut self) -> Result<bool>

Returns true if the CRC has been validated, or false if the computed CRC is different than the stored CRC. Returns an error if the chunk has not been fully read yet.

pub fn read_all(&mut self) -> Result<Vec<u8>>

Reads all of the remaining data from this chunk.

pub fn skip_remaining_bytes(self) -> Result<()>

Advances past the end of this chunk without reading the remaining bytes.

Trait Implementations

impl<'chunk, 'entry, F> Debug for EntryChunk<'chunk, 'entry, F>where F: File + Debug,

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

Formats the value using the given formatter.

impl<'chunk, 'entry, F> Drop for EntryChunk<'chunk, 'entry, F>where F: File,

fn drop(&mut self)

Executes the destructor for this type.

impl<'chunk, 'entry, F> Read for EntryChunk<'chunk, 'entry, F>where F: File,

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, Global>) -> 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 Selfwhere 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.