Struct region::Region

pub struct Region { /* fields omitted */ }

A descriptor for a mapped memory region.

The region encompasses zero or more pages (e.g. OpenBSD can have null-sized virtual pages).

Implementations

impl Region

pub fn as_ptr<T>(&self) -> *const T

Returns a pointer to the region’s base address.

The address is always aligned to the operating system’s page size.

pub fn as_mut_ptr<T>(&mut self) -> *mut T

Returns a mutable pointer to the region’s base address.

pub fn as_ptr_range<T>(&self) -> Range<*const T>

Returns two raw pointers spanning the region’s address space.

The returned range is half-open, which means that the end pointer points one past the last element of the region. This way, an empty region is represented by two equal pointers, and the difference between the two pointers represents the size of the region.

pub fn as_mut_ptr_range<T>(&mut self) -> Range<*mut T>

Returns two mutable raw pointers spanning the region’s address space.

pub fn as_range(&self) -> Range<usize>

Returns a range spanning the region’s address space.

pub fn is_committed(&self) -> bool

Returns whether the region is committed or not.

This is always true for all operating system’s, the exception being MEM_RESERVE pages on Windows.

pub fn is_readable(&self) -> bool

Returns whether the region is readable or not.

pub fn is_writable(&self) -> bool

Returns whether the region is writable or not.

pub fn is_executable(&self) -> bool

Returns whether the region is executable or not.

pub fn is_guarded(&self) -> bool

Returns whether the region is guarded or not.

pub fn is_shared(&self) -> bool

Returns whether the region is shared between processes or not.

pub fn len(&self) -> usize

Returns the size of the region in bytes.

The size is always aligned to a multiple of the operating system’s page size.

pub fn is_empty(&self) -> bool

Returns whether region is empty or not.

pub fn protection(&self) -> Protection

Returns the protection attributes of the region.

Trait Implementations

impl Clone for Region

fn clone(&self) -> Region

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Region

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

Formats the value using the given formatter.

impl Default for Region

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Region> for Region

fn eq(&self, other: &Region) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Region) -> bool

This method tests for !=.

impl Copy for Region

impl Eq for Region

impl Send for Region

impl StructuralEq for Region

impl StructuralPartialEq for Region

impl Sync for Region