Struct memmap2::RemapOptions

pub struct RemapOptions { /* private fields */ }

Options for Mmap::remap and MmapMut::remap.

Implementations

impl RemapOptions

pub fn new() -> Self

Creates a mew set of options for resizing a memory map.

pub fn may_move(self, may_move: bool) -> Self

Controls whether the memory map can be moved if it is not possible to resize it in place.

If false then the memory map is guaranteed to remain at the same address when being resized but attempting to resize will return an error if the new memory map would overlap with something else in the current process’ memory.

By default this is false.

may_move and StableDeref

If the stable_deref_trait feature is enabled then Mmap and MmapMut implement StableDeref. StableDeref promises that the memory map dereferences to a fixed address, however, calling remap with may_move set may result in the backing memory of the mapping being moved to a new address. This may cause UB in other code depending on the StableDeref guarantees.

Trait Implementations

impl Clone for RemapOptions

fn clone(&self) -> RemapOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RemapOptions

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

Formats the value using the given formatter.

impl Default for RemapOptions

fn default() -> RemapOptions

Returns the “default value” for a type.

impl Copy for RemapOptions