Struct alloc_madvise::Memory

pub struct Memory { /* private fields */ }

Allocated memory.

Example

const FOUR_MEGABYTES: usize = 4 * 1024 * 1024;

// Allocate 2 MiB of aligned, zeroed-out, sequential read memory.
// The memory will be automatically freed when it leaves scope.
let mut memory = Memory::allocate(FOUR_MEGABYTES, true, true).unwrap();

// Get a reference to a mutable slice.
let data: &mut [f32] = memory.as_mut();
data[0] = 1.234;
data[1] = 5.678;

// Get a reference to an immutable slice.
let reference: &[f32] = memory.as_ref();
assert_eq!(reference[0], 1.234);
assert_eq!(reference[1], 5.678);
assert_eq!(reference[2], 0.0);
assert_eq!(reference.len(), memory.len() / std::mem::size_of::<f32>());

Implementations

impl Memory

pub fn allocate( num_bytes: usize, sequential: bool, clear: bool, ) -> Result<Self, AllocationError>

Allocates memory of the specified number of bytes.

The optimal alignment will be determined by the number of bytes provided. If the amount of bytes is a multiple of 2MB, Huge/Large Page support is enabled.

Arguments

• num_bytes - The number of bytes to allocate.
• sequential - Whether or not the memory access pattern is sequential mostly.
• clear - Whether or not to zero out the allocated memory.

pub fn free(&mut self)

Frees memory of the specified number of bytes.

The memory instance is required to be created by allocate.

pub fn len(&self) -> usize

Returns the number of bytes allocated.

pub fn is_empty(&self) -> bool

Returns whether this instance has zero bytes allocated.

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

Returns a pointer to the data buffer.

Returns

A valid pointer.

pub fn as_ptr_mut(&mut self) -> *mut c_void

Returns a mutable pointer to the data buffer.

Returns

A valid pointer.

Trait Implementations

impl AsMut<[c_void]> for Memory

fn as_mut(&mut self) -> &mut [c_void]

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

impl AsMut<[f32]> for Memory

fn as_mut(&mut self) -> &mut [f32]

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

impl AsMut<[f64]> for Memory

fn as_mut(&mut self) -> &mut [f64]

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

impl AsMut<[i16]> for Memory

fn as_mut(&mut self) -> &mut [i16]

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

impl AsMut<[i32]> for Memory

fn as_mut(&mut self) -> &mut [i32]

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

impl AsMut<[i64]> for Memory

fn as_mut(&mut self) -> &mut [i64]

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

impl AsMut<[i8]> for Memory

fn as_mut(&mut self) -> &mut [i8]

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

impl AsMut<[isize]> for Memory

fn as_mut(&mut self) -> &mut [isize]

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

impl AsMut<[u16]> for Memory

fn as_mut(&mut self) -> &mut [u16]

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

impl AsMut<[u32]> for Memory

fn as_mut(&mut self) -> &mut [u32]

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

impl AsMut<[u64]> for Memory

fn as_mut(&mut self) -> &mut [u64]

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

impl AsMut<[u8]> for Memory

fn as_mut(&mut self) -> &mut [u8]

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

impl AsMut<[usize]> for Memory

fn as_mut(&mut self) -> &mut [usize]

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

impl AsRef<[c_void]> for Memory

fn as_ref(&self) -> &[c_void]

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

impl AsRef<[f32]> for Memory

fn as_ref(&self) -> &[f32]

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

impl AsRef<[f64]> for Memory

fn as_ref(&self) -> &[f64]

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

impl AsRef<[i16]> for Memory

fn as_ref(&self) -> &[i16]

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

impl AsRef<[i32]> for Memory

fn as_ref(&self) -> &[i32]

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

impl AsRef<[i64]> for Memory

fn as_ref(&self) -> &[i64]

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

impl AsRef<[i8]> for Memory

fn as_ref(&self) -> &[i8]

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

impl AsRef<[isize]> for Memory

fn as_ref(&self) -> &[isize]

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

impl AsRef<[u16]> for Memory

fn as_ref(&self) -> &[u16]

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

impl AsRef<[u32]> for Memory

fn as_ref(&self) -> &[u32]

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

impl AsRef<[u64]> for Memory

fn as_ref(&self) -> &[u64]

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

impl AsRef<[u8]> for Memory

fn as_ref(&self) -> &[u8]

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

impl AsRef<[usize]> for Memory

fn as_ref(&self) -> &[usize]

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

impl Debug for Memory

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

Formats the value using the given formatter.

impl Default for Memory

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Memory

fn drop(&mut self)

Executes the destructor for this type.