Struct PageRangeBox 

pub struct PageRangeBox<A: PageRangeAllocator>(/* private fields */);

Implementations

impl<A: PageRangeAllocator> PageRangeBox<A>

pub fn new(layout: PageLayout) -> Result<Self, AllocError>

pub unsafe fn from_raw(range: PageRange) -> Self

pub fn into_raw(b: Self) -> PageRange

Methods from Deref<Target = PageRange>

pub fn start(self) -> usize

Returns the start address of this page range.

Examples

use free_list::PageRange;

let range = PageRange::new(0x1000, 0x5000).unwrap();
assert_eq!(range.start(), 0x1000);

pub fn end(self) -> usize

Returns the end address of this page range.

Examples

use free_list::PageRange;

let range = PageRange::new(0x1000, 0x5000).unwrap();
assert_eq!(range.end(), 0x5000);

pub fn len(self) -> NonZero<usize>

Returns the length of this page range in bytes.

Examples

use free_list::PageRange;

let range = PageRange::new(0x1000, 0x5000).unwrap();
assert_eq!(range.len().get(), 0x4000);

pub fn pages(self) -> NonZero<usize>

Returns the length of this page range in pages of size PAGE_SIZE.

Examples

use free_list::PageRange;

let range = PageRange::new(0x1000, 0x5000).unwrap();
assert_eq!(range.pages().get(), 4);

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

Returns true if self overlaps with other.

This property is exclusive with PageRange::touches.

Examples

use free_list::PageRange;

let a = PageRange::new(0x1000, 0x5000).unwrap();
let b = PageRange::new(0x3000, 0x7000).unwrap();
assert!(a.overlaps(b));

pub fn touches(self, other: PageRange) -> bool

Returns true if self touches other.

This is exclusive with PageRange::overlaps.

Examples

use free_list::PageRange;

let a = PageRange::new(0x1000, 0x5000).unwrap();
let b = PageRange::new(0x5000, 0x9000).unwrap();
assert!(a.touches(b));

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

Returns true if self contains other.

Examples

use free_list::PageRange;

let a = PageRange::new(0x1000, 0x5000).unwrap();
let b = PageRange::new(0x1000, 0x3000).unwrap();
assert!(a.contains(b));

pub fn fit(self, layout: PageLayout) -> Option<PageRange>

Returns the first page range that is contained in self and satisfies layout.

Examples

use free_list::{PageLayout, PageRange};

let range = PageRange::new(0x1000, 0x5000).unwrap();
let layout = PageLayout::from_size_align(0x3000, 0x2000).unwrap();
let expected = PageRange::new(0x2000, 0x5000).unwrap();
assert_eq!(range.fit(layout), Some(expected));

pub fn and(self, rhs: PageRange) -> Option<PageRange>

Returns the intersection of self and rhs as a new PageRange if non-empty.

Examples

use free_list::PageRange;

let lhs = PageRange::new(0x1000, 0x3000).unwrap();
let rhs = PageRange::new(0x2000, 0x5000).unwrap();
let expected = PageRange::new(0x2000, 0x3000).unwrap();
assert_eq!(lhs.and(rhs), Some(expected));

Trait Implementations

impl<A: PageRangeAllocator> Deref for PageRangeBox<A>

type Target = PageRange

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<A: PageRangeAllocator> Drop for PageRangeBox<A>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.