Skip to main content

MemoryMap

Struct MemoryMap 

Source
pub struct MemoryMap<'a, T> { /* private fields */ }

Implementations§

Source§

impl<'a, T> MemoryMap<'a, T>

Source

pub unsafe fn new(ptr: *const T, size: usize) -> Self

Creates a new MemoryMap instance from a pointer and size.

§Safety

ptr must be a valid pointer to a memory-mapped region of size bytes.

Source

pub fn size_bytes(&self) -> usize

Returns the mapped region size in bytes.

Source

pub fn as_slice(&self) -> &[T]

Borrows the mapped region as an immutable slice.

Source

pub fn madvise(&self, advice: &[Madvice]) -> Result<(), Error>

Applies one or more access-pattern hints to the mapped region on Unix.

Source

pub unsafe fn from_file<F>(fd: &'a F, size: usize) -> Result<Self, Error>
where F: AsRawFd,

Creates a new MemoryMap instance from a file descriptor and size.

§Safety

fd must be a valid file descriptor. The file descriptor must be open and readable. Size must be a valid size for the file descriptor.

Source

pub fn close(self) -> Result<(), Error>

Explicitly unmaps the region and reports cleanup errors.

Trait Implementations§

Source§

impl<T> Drop for MemoryMap<'_, T>

Source§

fn drop(&mut self)

Unmaps the region when the mapping goes out of scope.

Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

Auto Trait Implementations§

§

impl<'a, T> !RefUnwindSafe for MemoryMap<'a, T>

§

impl<'a, T> !Send for MemoryMap<'a, T>

§

impl<'a, T> !Sync for MemoryMap<'a, T>

§

impl<'a, T> !UnwindSafe for MemoryMap<'a, T>

§

impl<'a, T> Freeze for MemoryMap<'a, T>

§

impl<'a, T> Unpin for MemoryMap<'a, T>

§

impl<'a, T> UnsafeUnpin for MemoryMap<'a, T>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.