Struct memory_range::MemoryRange

pub struct MemoryRange { /* private fields */ }

Represents a page-aligned byte range of memory.

This type has a stable Protobuf representation, and can be directly used in saved state.

Implementations

impl MemoryRange

pub const MAX_ADDRESS: u64 = 18_446_744_073_709_547_520u64

The maximum address that can be represented by a MemoryRange.

pub const fn new(range: Range<u64>) -> Self

Returns a new range for the given guest address range.

Panics if the start or end are not 4KB aligned or if the start is after the end.

pub const fn try_new(range: Range<u64>) -> Result<Self, InvalidMemoryRange>

Returns a new range for the given guest address range.

Returns None if the start or end are not 4KB aligned or if the start is after the end.

pub fn bounding(range: Range<u64>) -> Self

Returns the smallest 4K-aligned range that contains the given address range.

Panics if the start is after the end or if the end address is in the last page of the 64-bit space.

pub fn from_4k_gpn_range(range: Range<u64>) -> Self

Returns a new range for the given guest 4KB page range.

Panics if the start is after the end or if the start address or end address overflow.

pub const EMPTY: Self = _

The empty range, with start and end addresses of zero.

pub fn start(&self) -> u64

The start address.

pub fn start_4k_gpn(&self) -> u64

The start address as a 4KB page number.

pub fn end_4k_gpn(&self) -> u64

The end address as a 4KB page number.

pub fn page_count_4k(&self) -> u64

The number of 4KB pages in the range.

pub fn page_count_2m(&self) -> u64

The number of 2MB pages in the range.

pub fn end(&self) -> u64

The end address.

pub fn len(&self) -> u64

The length of the range in bytes.

pub fn is_empty(&self) -> bool

Check if the range is empty.

pub fn alignment(&self, base: u64) -> u64

Gets the biggest page size possible for the range.

pub fn aligned_subrange(&self, alignment: u64) -> Self

Returns the largest range contained in this range whose start and end are aligned to alignment bytes. This may be the empty range.

Panics if alignment is not a power of two.

pub fn overlaps(&self, other: &Self) -> bool

Returns whether self and other overlap.

pub fn contains(&self, other: &Self) -> bool

Returns whether self contains other.

pub fn contains_addr(&self, addr: u64) -> bool

Returns whether self contains the byte at addr.

pub fn offset_of(&self, addr: u64) -> Option<u64>

Returns the byte offset of addr within the range, if it is contained.

pub fn intersection(&self, other: &Self) -> Self

Returns the intersection of self and other.

pub fn split_at_offset(&self, offset: u64) -> (Self, Self)

Split the range at the given byte offset within the range.

Panics if offset is not within the range or is not page-aligned.

Trait Implementations

impl Clone for MemoryRange

fn clone(&self) -> MemoryRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MemoryRange

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

Formats the value using the given formatter.

impl DefaultEncoding for MemoryRange

type Encoding = TableEncoder

The encoding to use for the serialization.

impl DescribeTable for MemoryRange

const DESCRIPTION: MessageDescription<'static> = _

The protobuf message description for this type.

impl Display for MemoryRange

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

Formats the value using the given formatter.

impl From<MemoryRange> for Range<u64>

fn from(range: MemoryRange) -> Self

Converts to this type from the input type.

impl Inspect for MemoryRange

fn inspect(&self, req: Request<'_>)

Inspects the object.

impl Ord for MemoryRange

fn cmp(&self, other: &MemoryRange) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MemoryRange

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MemoryRange

fn partial_cmp(&self, other: &MemoryRange) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'encoding, AnyR: 'static> StructDecodeMetadata<'encoding, AnyR> for MemoryRange

const DECODERS: &'static [ErasedDecoderEntry] = _

The list of decoder vtables.

impl<AnyR: 'static> StructEncodeMetadata<AnyR> for MemoryRange

const ENCODERS: &'static [ErasedEncoderEntry] = _

The list of encoder vtables.

impl StructMetadata for MemoryRange

const NUMBERS: &'static [u32] = _

The field numbers for each field.

const OFFSETS: &'static [usize] = _

The byte offset to each field within the struct.

impl TryFrom<Range<u64>> for MemoryRange

type Error = InvalidMemoryRange

The type returned in the event of a conversion error.

fn try_from(range: Range<u64>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Range<usize>> for MemoryRange

type Error = InvalidMemoryRange

The type returned in the event of a conversion error.

fn try_from(range: Range<usize>) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for MemoryRange

impl Downcast<MemoryRange> for MemoryRange

impl Eq for MemoryRange

impl StructuralPartialEq for MemoryRange