Struct RangeInclusive

pub struct RangeInclusive { /* private fields */ }

A closed interval range [start, end]. The range describes a memory slot which is assigned by the VMM to a device.

Example

use vm_allocator::RangeInclusive;

let r = RangeInclusive::new(0x0, 0x100).unwrap();
assert_eq!(r.len(), 0x101);
assert_eq!(r.start(), 0x0);
assert_eq!(r.end(), 0x100);

// Check if a region contains another region.
let other = RangeInclusive::new(0x50, 0x80).unwrap();
assert!(r.contains(&other));

// Check if a region overlaps with another one.
let other = RangeInclusive::new(0x99, 0x150).unwrap();
assert!(r.overlaps(&other));

Implementations

impl RangeInclusive

pub fn new(start: u64, end: u64) -> Result<Self>

Creates a new RangeInclusive.

pub fn len(&self) -> u64

Returns the length of the range.

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

Returns true if the regions overlap.

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

Returns true if the current range contains the range passed as a parameter.

pub fn start(&self) -> u64

Returns the lower boundary of the range.

pub fn end(&self) -> u64

Returns the upper boundary of the range.

Trait Implementations

impl Clone for RangeInclusive

fn clone(&self) -> RangeInclusive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RangeInclusive

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

Formats the value using the given formatter.

impl Hash for RangeInclusive

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RangeInclusive

fn cmp(&self, other: &RangeInclusive) -> 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,

Restrict a value to a certain interval.

impl PartialEq for RangeInclusive

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

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

const 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 RangeInclusive

fn partial_cmp(&self, other: &RangeInclusive) -> 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 Copy for RangeInclusive

impl Eq for RangeInclusive

impl StructuralPartialEq for RangeInclusive