Struct VirtualRange 

pub struct VirtualRange { /* private fields */ }

A reserved range of virtual addresses with nothing behind it yet.

Reserving costs address space, not memory. Blocks are mapped in afterwards with VirtualRange::map, and the range is readable only where something has been mapped — touching an unmapped offset faults rather than reading zeroes, which is deliberate: a silent zero would look like KV that was written but empty.

Implementations

impl VirtualRange

pub fn reserve(len: usize) -> Result<Self, VirtualMemoryError>

Reserve len bytes of address space.

len must be a multiple of granularity.

pub fn len(&self) -> usize

Bytes of address space reserved.

pub fn is_empty(&self) -> bool

Whether the reservation covers no bytes.

Always false: a zero-length reservation is refused at construction.

pub fn mapped_bytes(&self) -> usize

Bytes currently backed by a mapped block.

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

The base address. Only offsets that have been mapped may be read.

pub fn as_mut_ptr(&mut self) -> *mut u8

The base address, mutable.

pub fn map( &mut self, offset: usize, len: usize, ) -> Result<(), VirtualMemoryError>

Back offset..offset + len with freshly committed memory.

Both offset and len must be multiples of granularity.

pub fn unmap(&mut self, offset: usize) -> Result<(), VirtualMemoryError>

Release the block backing offset, leaving the address space reserved.

The offset must be one previously passed to Self::map; releasing a sub-range would strand the remainder of the block.

pub unsafe fn slice_unchecked(&self, offset: usize, len: usize) -> &[u8]

A read-only view of a mapped span.

Safety

The caller must ensure offset..offset + len is entirely mapped. Reading unmapped address space faults.

pub unsafe fn slice_unchecked_mut( &mut self, offset: usize, len: usize, ) -> &mut [u8]

A mutable view of a mapped span.

Safety

The caller must ensure offset..offset + len is entirely mapped.

Trait Implementations

impl Debug for VirtualRange

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

Formats the value using the given formatter.

impl Drop for VirtualRange

fn drop(&mut self)

Executes the destructor for this type.

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.

impl Send for VirtualRange

impl Sync for VirtualRange