Struct buf_file::BufFile

pub struct BufFile<F: Write + Read + Seek> { /* fields omitted */ }

Methods

impl<F: Write + Read + Seek> BufFile<F>

fn new(file: F) -> Result<BufFile<F>, Error>

Creates a new BufFile.

fn with_capacity(slabs: usize, file: F) -> Result<BufFile<F>, Error>

Creates a new BufFile with the specified number of slabs.

fn into_inner(self) -> Result<F, Error>

Returns the underlying Read + Write + Sync struct after writing to disk.

fn set_slabs(&mut self, num_slabs: usize) -> Result<(), Error>

Change the number of slabs to the desired number. If there are more slabs currently loaded than num_slabs, then the least frequently used slab(s) will be removed until it is equal. Every removed slab gets written to disk, creating the possibility for I/O errors.

fn cursor_loc(&self) -> u64

Returns the current cursor_loc

Trait Implementations

impl<F: Write + Read + Seek> Read for BufFile<F>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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.

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, placing them into buf.

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<F: Write + Read + Seek> Write for BufFile<F>

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

Write a buffer into this object, returning how many bytes were written.

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

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

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

impl<F: Write + Read + Seek> Seek for BufFile<F>

fn seek(&mut self, pos: SeekFrom) -> Result<u64, Error>

Seek to an offset, in bytes, in a stream.

impl<F: Read + Write + Seek> Drop for BufFile<F>

fn drop(&mut self)

Write all of the slabs to disk before closing the file.