Struct memory_structs::PageRange

pub struct PageRange(_);

A range of Pages that are contiguous in virtual memory.

Implementations

impl PageRange

pub const fn new(start: Page, end: Page) -> PageRange

Creates a new range of Pages that spans from start to end, both inclusive bounds.

pub const fn empty() -> PageRange

Creates a PageRange that will always yield None when iterated.

pub fn from_virt_addr(
    starting_addr: VirtualAddress,
    size_in_bytes: usize
) -> PageRange

A convenience method for creating a new PageRange that spans all Pages from the given VirtualAddress to an end bound based on the given size.

pub const fn start_address(&self) -> VirtualAddress

Returns the VirtualAddress of the starting Page in this PageRange.

pub const fn size_in_pages(&self) -> usize

Returns the number of Pages covered by this iterator.

Use this instead of Iterator::count() method. This is instant, because it doesn’t need to iterate over each entry, unlike normal iterators.

pub const fn size_in_bytes(&self) -> usize

Returns the size of this range in number of bytes.

pub fn contains_address(&self, addr: VirtualAddress) -> bool

Returns true if this PageRange contains the given VirtualAddress.

pub fn offset_of_address(&self, addr: VirtualAddress) -> Option<usize>

Returns the offset of the given VirtualAddress within this PageRange, i.e., addr - self.start_address().

If the given addr is not covered by this range of Pages, this returns None.

Examples

If the range covers addresses 0x2000 to 0x4000, then offset_of_address(0x3500) would return Some(0x1500).

pub fn address_at_offset(&self, offset: usize) -> Option<VirtualAddress>

Returns the VirtualAddress at the given offset into this PageRangewithin this PageRange, i.e., addr - self.start_address().

If the given offset is not within this range of Pages, this returns None.

Examples

If the range covers addresses 0x2000 to 0x4000, then address_at_offset(0x1500) would return Some(0x3500).

pub fn to_extended(&self, to_include: Page) -> PageRange

Returns a new separate PageRange that is extended to include the given Page.

pub fn overlap(&self, other: &PageRange) -> Option<PageRange>

Returns an inclusive PageRange representing the Pages that overlap across this PageRange and the given other PageRange.

If there is no overlap between the two ranges, None is returned.

Methods from Deref<Target = RangeInclusive<Page>>

pub fn start(&self) -> &Idx

Returns the lower bound of the range (inclusive).

When using an inclusive range for iteration, the values of start() and end() are unspecified after the iteration ended. To determine whether the inclusive range is empty, use the is_empty() method instead of comparing start() > end().

Note: the value returned by this method is unspecified after the range has been iterated to exhaustion.

Examples

assert_eq!((3..=5).start(), &3);

pub fn end(&self) -> &Idx

Returns the upper bound of the range (inclusive).

When using an inclusive range for iteration, the values of start() and end() are unspecified after the iteration ended. To determine whether the inclusive range is empty, use the is_empty() method instead of comparing start() > end().

Note: the value returned by this method is unspecified after the range has been iterated to exhaustion.

Examples

assert_eq!((3..=5).end(), &5);

pub fn contains<U>(&self, item: &U) -> boolwhere
    Idx: PartialOrd<U>,
    U: PartialOrd<Idx> + ?Sized,

Returns true if item is contained in the range.

Examples

assert!(!(3..=5).contains(&2));
assert!( (3..=5).contains(&3));
assert!( (3..=5).contains(&4));
assert!( (3..=5).contains(&5));
assert!(!(3..=5).contains(&6));

assert!( (3..=3).contains(&3));
assert!(!(3..=2).contains(&3));

assert!( (0.0..=1.0).contains(&1.0));
assert!(!(0.0..=1.0).contains(&f32::NAN));
assert!(!(0.0..=f32::NAN).contains(&0.0));
assert!(!(f32::NAN..=1.0).contains(&1.0));

This method always returns false after iteration has finished:

let mut r = 3..=5;
assert!(r.contains(&3) && r.contains(&5));
for _ in r.by_ref() {}
// Precise field values are unspecified here
assert!(!r.contains(&3) && !r.contains(&5));

pub fn is_empty(&self) -> bool

Returns true if the range contains no items.

Examples

assert!(!(3..=5).is_empty());
assert!(!(3..=3).is_empty());
assert!( (3..=2).is_empty());

The range is empty if either side is incomparable:

assert!(!(3.0..=5.0).is_empty());
assert!( (3.0..=f32::NAN).is_empty());
assert!( (f32::NAN..=5.0).is_empty());

This method returns true after iteration has finished:

let mut r = 3..=5;
for _ in r.by_ref() {}
// Precise field values are unspecified here
assert!(r.is_empty());

Trait Implementations

impl Clone for PageRange

fn clone(&self) -> PageRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PageRange

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

Formats the value using the given formatter.

impl Deref for PageRange

type Target = RangeInclusive<Page>

The resulting type after dereferencing.

fn deref(&self) -> &RangeInclusive<Page>

Dereferences the value.

impl DerefMut for PageRange

fn deref_mut(&mut self) -> &mut RangeInclusive<Page>

Mutably dereferences the value.

impl IntoIterator for PageRange

type Item = Page

The type of the elements being iterated over.

type IntoIter = RangeInclusive<Page>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq<PageRange> for PageRange

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

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

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

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

impl Eq for PageRange

impl StructuralEq for PageRange

impl StructuralPartialEq for PageRange