Struct Area

pub struct Area { /* private fields */ }

Represents an arbitrary memory area between two Addrs.

Note that there are several edge-cases around wrapping. For example, Area::first_address_after may return a number smaller than Area::start_addr if the area wraps around.

The functions implemented on Area take these edge-cases into account.

Implementations

impl Area

pub fn new(addr: Addr, size: u64) -> Area

size should be smaller than 2**63. This is not checked.

pub fn contains(&self, addr: Addr) -> bool

Returns true if the area contains the address addr.

pub fn start_addr(&self) -> Addr

Returns the start address of the area

pub fn first_address_after(&self) -> Addr

Returns the first address after the area. May be smaller than the start address if the area wraps around.

pub fn extend_before(&self, size: u64) -> Area

Extends the start of the address by size bytes.

pub fn crosses_page_bounds(&self, page_bits: usize) -> bool

Returns true if the page of the first address in the area and the page of the last address in the area are different.

pub fn shares_page_with<A: Arch>(&self, other: &Area) -> bool

Returns true if the areas have at least one page which is shared by both.

pub fn overlaps_with(&self, other: &Area) -> bool

Returns true if the area overlaps with other.

pub fn size(&self) -> u64

Returns the size of the area.

Trait Implementations

impl Clone for Area

fn clone(&self) -> Area

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Area

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

Formats the value using the given formatter.

impl Hash for Area

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 PartialEq for Area

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

impl Eq for Area

impl StructuralPartialEq for Area