Struct fst::raw::MmapReadOnly

pub struct MmapReadOnly {
    // some fields omitted
}

A read only view into a memory map.

Reading a memory map is unsafe because we cannot guarantee that its underlying memory is not mutated by external processes. This read only memory map guarantees that consumers can at least never modify the underlying data.

It is principally useful for controlling which region of a file an Fst reads. Taking a slice from it is still considered unsafe.

Methods

impl MmapReadOnly

fn open(file: &File) -> Result<MmapReadOnly>

Create a new memory map from an existing file handle.

fn open_path<P: AsRef<Path>>(path: P) -> Result<MmapReadOnly>

Open a new memory map from the path given.

fn len(&self) -> usize

Returns the size in byte of the memory map.

If it is a range, the size is the size of the range.

fn range(&self, offset: usize, len: usize) -> MmapReadOnly

Slice this memory map to a new offset and len.

If the new range is outside the bounds of self, then this method panics.

unsafe fn as_slice(&self) -> &[u8]

Read the memory map as a &[u8].

Trait Implementations

impl Clone for MmapReadOnly

fn clone(&self) -> MmapReadOnly

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Mmap> for MmapReadOnly

fn from(mmap: Mmap) -> MmapReadOnly

Performs the conversion.