Struct WritableMemoryMap

pub struct WritableMemoryMap { /* private fields */ }

Implementations

impl WritableMemoryMap

pub fn map_file(file: File) -> Result<Self, MapError>

Maps a writable File into mutable memory.

Errors

• MapError is returned if memory mapping fails, e.g. if the file inaccessible or read-only.

impl WritableMemoryMap

pub fn map_path<P: AsRef<Path>>(file_path: P) -> Result<Self, MapError>

Opens a File and maps it into mutable memory.

Errors

Returns a MapError if mapping fails for any reason.

impl WritableMemoryMap

pub fn read(&self) -> ArcRwLockReadGuard<RawRwLock, MmapMut>

pub fn write(&self) -> ArcRwLockWriteGuard<RawRwLock, MmapMut>

pub fn as_mut_ptr(&self) -> *mut u8

pub fn as_ptr(&self) -> *const u8

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl AsRef<Arc<RwLock<RawRwLock, MmapMut>>> for WritableMemoryMap

fn as_ref(&self) -> &Arc<RwLock<MmapMut>>

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<File> for WritableMemoryMap

fn as_ref(&self) -> &File

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RwLock<RawRwLock, MmapMut>> for WritableMemoryMap

fn as_ref(&self) -> &RwLock<MmapMut>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for WritableMemoryMap

fn clone(&self) -> WritableMemoryMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WritableMemoryMap

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

Formats the value using the given formatter.

impl Deref for WritableMemoryMap

type Target = RwLock<RawRwLock, MmapMut>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<&WriteGuard> for WritableMemoryMap

fn from(value: &WriteGuard) -> Self

Converts to this type from the input type.

impl From<WritableMemoryMap> for ReadGuard

fn from(value: WritableMemoryMap) -> Self

Converts to this type from the input type.

impl From<WritableMemoryMap> for WriteGuard

fn from(value: WritableMemoryMap) -> Self

Converts to this type from the input type.

impl From<WriteGuard> for WritableMemoryMap

fn from(value: WriteGuard) -> Self

Converts to this type from the input type.