MemoryMap

Enum MemoryMap

pub enum MemoryMap {
    Readable(ReadableMemoryMap),
    Writable(WritableMemoryMap),
}

Variants§

Readable(ReadableMemoryMap)

Writable(WritableMemoryMap)

Implementations§

impl MemoryMap

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

§Errors

Returns MapError if mapping fails for any reason.

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

§Errors

Returns MapError if mapping fails for any reason.

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

§Errors

Returns MapError if mapping fails for any reason.

pub fn read(&self) -> ReadGuard

pub fn into_read(self) -> ReadGuard

pub fn try_write(&self) -> Result<WriteGuard, DerefError>

§Errors

Returns ReadOnly if memory map is read-only.

pub fn try_into_write(self) -> Result<WriteGuard, DerefError>

§Errors

Returns ReadOnly if memory map is read-only.

pub fn read_with<F, R>(&self, closure: F) -> R
where F: FnOnce(&[u8]) -> R,

pub fn try_write_with<F, R>(&self, closure: F) -> Result<R, DerefError>
where F: FnOnce(&mut [u8]) -> R,

§Errors

Returns ReadOnly if memory map is read-only.

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

pub fn try_as_mut_ptr(&self) -> Result<*mut u8, DerefError>

§Errors

Returns ReadOnly if memory map is read-only.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations§

impl Clone for MemoryMap

fn clone(&self) -> MemoryMap

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for MemoryMap

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

Formats the value using the given formatter. Read more

impl From<&MemoryMap> for ReadGuard

fn from(value: &MemoryMap) -> Self

Converts to this type from the input type.

impl From<&ReadGuard> for MemoryMap

fn from(value: &ReadGuard) -> Self

Converts to this type from the input type.

impl From<&WriteGuard> for MemoryMap

fn from(value: &WriteGuard) -> Self

Converts to this type from the input type.

impl From<MemoryMap> for ReadGuard

fn from(value: MemoryMap) -> Self

Converts to this type from the input type.

impl From<ReadGuard> for MemoryMap

fn from(value: ReadGuard) -> Self

Converts to this type from the input type.

impl From<WriteGuard> for MemoryMap

fn from(value: WriteGuard) -> Self

Converts to this type from the input type.

impl TryFrom<&MemoryMap> for WriteGuard

type Error = DerefError

The type returned in the event of a conversion error.

fn try_from(value: &MemoryMap) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<MemoryMap> for WriteGuard

type Error = DerefError

The type returned in the event of a conversion error.

fn try_from(value: MemoryMap) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for MemoryMap

impl !RefUnwindSafe for MemoryMap

impl Send for MemoryMap

impl Sync for MemoryMap

impl Unpin for MemoryMap

impl !UnwindSafe for MemoryMap

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.