Struct d4_framefile::RandFile

pub struct RandFile<'a, Mode: AccessMode, T: 'a> { /* fields omitted */ }

The file object that supports random access. Since in D4 file, we actually use a random access file mode, which means all the read and write should provide the address. And this is the object that provides the low level random access interface.

At the same time, this RandFile object is synchronized, which means we guarantee the thread safety that each block of data is written to file correctly.

The type parameter Mode is served as a type marker that identify the ability of this file.

The rand file provides a offset-based file access API and data can be read and write from the specified address in blocks. But rand file itself doesn't tracking the block size and it's the upper layer's responsibility to determine the correct block beginning.

Implementations

impl<'a, M: AccessMode, T: 'a> RandFile<'a, M, T>

pub fn lock(&mut self, update_fn: Box<dyn FnOnce() + Send + 'a>) -> Result<Self>

impl<T: Read + Seek, '_> RandFile<'_, ReadOnly, T>

pub fn for_read_only(inner: T) -> Self

The convenient helper function to create a read-only random file

• inner: The underlying implementation for this backend

impl<T: Read + Write + Seek, '_> RandFile<'_, ReadWrite, T>

pub fn for_read_write(inner: T) -> Self

The convenient helper function to create a read-write random file

• inner: The underlying implementation for this backend

impl<T: CanRead<File>, '_> RandFile<'_, T, File>

pub fn mmap(&self, offset: u64, size: usize) -> Result<MappingHandle>

impl<T: CanRead<File> + CanWrite<File>, '_> RandFile<'_, T, File>

pub fn mmap_mut(&mut self, offset: u64, size: usize) -> Result<MappingHandleMut>

impl<Mode: CanWrite<T>, T: Write + Seek, '_> RandFile<'_, Mode, T>

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

Append a block to the random accessing file the return value is the relative address compare to the last accessed block.

• buf: The data buffer that needs to be write
• returns: The absolute address of the block that has been written to the file.

pub fn update_block(&mut self, offset: u64, buf: &[u8]) -> Result<()>

Update a data block with the given data buffer.

• offset: The offset of the data block
• buf: The data buffer to write

pub fn reserve_block(&mut self, size: usize) -> Result<u64>

Reserve some space in the rand file. This is useful when we want to reserve a data block for future use. This is very useful for some volatile data (for example the directory block), etc. And later, we are able to use update_block function to keep the reserved block up-to-dated

impl<Mode: CanRead<T>, T: Read + Seek, '_> RandFile<'_, Mode, T>

pub fn size(&mut self) -> Result<u64>

pub fn read_block(&mut self, addr: u64, buf: &mut [u8]) -> Result<usize>

Read a block from the random accessing file the size of the buffer slice is equal to the number of bytes that is requesting But there might not be enough bytes available for read, thus we always return the actual number of bytes is loaded

Trait Implementations

impl<M: AccessMode, T, '_> Clone for RandFile<'_, M, T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<M: AccessMode, T, '_> Drop for RandFile<'_, M, T>

fn drop(&mut self)

Executes the destructor for this type.