Struct Span

pub struct Span { /* private fields */ }

Represents an interval of memory [base, acme)

Use get_base_acme to retrieve base and acme directly.

Empty Spans

Note that where base >= acme, the Span is considered empty, in which case the specific values of base and acme are considered meaningless.

• Most functions will no-op or return None for empty spans (check the docs).
• Empty spans contain nothing and overlap with nothing.
• Empty spans are contained by all sized spans.

Implementations

impl Span

pub const fn is_empty(self) -> bool

Returns whether base >= acme.

pub const fn is_sized(self) -> bool

Returns whether base < acme.

pub const fn size(self) -> usize

Returns the size of the span, else zero if base >= span.

pub const fn get_base_acme(self) -> Option<(usize, usize)>

If self isn’t empty, returns (base, acme)

pub const fn empty() -> Self

Create an empty span.

pub const fn new(base: usize, acme: usize) -> Self

Create a new span.

pub const fn from_base_size(base: usize, size: usize) -> Self

Creates a Span given a base and a size.

Panics

Panics if base + size overflows.

pub fn from_ptr_size(ptr: *mut u8, size: usize) -> Self

pub const fn to_ptr_range(self) -> Option<Range<*mut u8>>

Returns None if self is empty.

pub const fn to_slice(self) -> Option<*mut [u8]>

Returns None if self is empty.

pub const fn contains(self, addr: usize) -> bool

Returns whether self contains addr.

Empty spans contain nothing.

pub fn contains_ptr(self, ptr: *mut u8) -> bool

Returns whether self contains ptr.

Empty spans contain nothing.

pub const fn contains_span(self, other: Span) -> bool

Returns whether self contains other.

Empty spans are contained by any span, even empty ones.

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

Returns whether some of self overlaps with other.

Empty spans don’t overlap with anything.

pub const fn word_align_inward(self) -> Self

Aligns base upward and acme downward by align_of::<usize>().

pub const fn word_align_outward(self) -> Self

Aligns base downward and acme upward by align_of::<usize>().

pub const fn above(self, min: usize) -> Self

Raises base if base is smaller than min.

pub const fn below(self, max: usize) -> Self

Lowers acme if acme is greater than max.

pub const fn fit_within(self, other: Span) -> Self

Returns a span that other contains by raising base or lowering acme.

If other is empty, returns other.

pub const fn fit_over(self, other: Self) -> Self

Returns a span that contains other by extending self.

If other is empty, returns self, as all spans contain any empty span.

pub const fn extend(self, low: usize, high: usize) -> Self

Lower base by low and raise acme by high.

Does nothing if self is empty.

Panics

Panics if lowering base by low or raising acme by high under/overflows.

pub const fn truncate(self, low: usize, high: usize) -> Span

Raise base by low and lower acme by high.

If self is empty, self is returned.

Trait Implementations

impl Clone for Span

fn clone(&self) -> Span

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Span

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

Formats the value using the given formatter.

impl Default for Span

fn default() -> Self

Returns the “default value” for a type.

impl Display for Span

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

Formats the value using the given formatter.

impl From<&mut [u8]> for Span

fn from(value: &mut [u8]) -> Self

Converts to this type from the input type.

impl From<*mut [u8]> for Span

fn from(value: *mut [u8]) -> Self

Converts to this type from the input type.

impl From<Range<*mut u8>> for Span

fn from(value: Range<*mut u8>) -> Self

Converts to this type from the input type.

impl From<Range<usize>> for Span

fn from(value: Range<usize>) -> Self

Converts to this type from the input type.

impl PartialEq for Span

fn eq(&self, other: &Self) -> 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 Span

impl Eq for Span