Struct guestmem::ranges::PagedRange

pub struct PagedRange<'a> { /* private fields */ }

A range of guest memory spanning multiple discontiguous pages.

This is represented by an offset, a length, and a list of pages. The range may span the first and last pages only partially, but the interior pages are completely covered by the range.

Implementations

impl<'a> PagedRange<'a>

pub const PAGE_SIZE: usize = 4_096usize

The page size for GPNs. This is always 4KB.

pub const fn new(offset: usize, len: usize, gpns: &'a [u64]) -> Option<Self>

Creates a new range over gpns, starting at offset bytes into the page list, extending for len bytes.

Returns None if offset or len are out of bounds.

pub const fn empty() -> Self

Returns the empty range.

pub fn try_subrange(&self, offset: usize, len: usize) -> Option<Self>

Returns a subrange of this range, or None if the subrange is outside this range.

pub fn subrange(&self, offset: usize, len: usize) -> Self

Returns a subrange of this range.

Panics if the subrange is outside this range.

pub fn len(&self) -> usize

Returns the length of the range in bytes.

pub fn is_empty(&self) -> bool

Returns whether the range is empty.

pub fn offset(&self) -> usize

Returns the byte offset into the first page of the range.

pub fn gpns(&self) -> &'a [u64]

Returns the range’s list of page numbers.

pub fn skip(&mut self, len: usize)

Skips the first len bytes of the range.

Panics if len is larger than the range’s length.

pub fn truncate(&mut self, len: usize)

Truncates the range to len bytes.

Panics if len is larger than the range’s length.

pub fn split(self, offset: usize) -> (Self, Self)

Splits the range at offset.

Panics if offset is outside the range.

pub fn try_split(self, offset: usize) -> Option<(Self, Self)>

Splits the range at offset, returning None if offset is outside the range.

pub fn pop_front_range(&mut self) -> Option<Result<AddressRange, InvalidGpn>>

Removes and returns the first contiguous range.

pub fn reader(self, mem: &'a GuestMemory) -> PagedRangeReader<'a>

Returns a MemoryRead implementation.

pub fn writer(self, mem: &'a GuestMemory) -> PagedRangeWriter<'a>

Returns a MemoryWrite implementation.

pub fn ranges(self) -> PagedRangeRangeIter<'a>

Returns an iterator over the AddressRanges represented by this range.

Trait Implementations

impl<'a> Clone for PagedRange<'a>

fn clone(&self) -> PagedRange<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PagedRange<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for PagedRange<'a>