Struct contiguous_mem::ByteRange

pub struct ByteRange(pub usize, pub usize);

Represents a range of bytes in AllocationTracker and ContiguousMemoryStorage.

Tuple Fields

0: usize

Inclusive lower bound of this byte range.

1: usize

Exclusive upper bound of this byte range.

Implementations

impl ByteRange

pub fn new(from: usize, to: usize) -> Self

Constructs a new byte range, ensuring that from and to are ordered correctly.

pub fn new_unchecked(from: usize, to: usize) -> Self

Constructs a new byte range without checking from and to ordering.

pub fn aligned(&self, alignment: usize) -> Self

Aligns this byte range to the provided alignment.

pub fn cap_size(&self, size: usize) -> Option<Self>

Caps the size of this byte range to the provided size and returns it. If the size of this byte range is lesser than the required size, None is returned instead.

pub fn offset(&self, offset: usize) -> Self

Offsets this byte range by a provided unsigned offset.

pub fn offset_signed(&self, offset: isize) -> Self

Offsets this byte range by a provided signed offset.

pub fn len(&self) -> usize

Returns length of this byte range.

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

Returns true if this byte range contains another byte range other.

pub fn difference_unchecked(&self, other: Self) -> (Self, Self)

Returns two byte ranges that remain when another other range is removed from this one.

It is possible for either or both of the returned byte ranges to have a length of 0 if other is aligned with either the upper or lower bound of this range, or if it is equal to this range.

pub fn merge_unchecked(&self, other: Self) -> Self

Merges this byte range with other and returns a byte range that contains both.

pub fn merge_in_unchecked(&mut self, other: Self)

Merges another other byte range into this one, resulting in a byte range that contains both.

Trait Implementations

impl Clone for ByteRange

fn clone(&self) -> ByteRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ByteRange

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

Formats the value using the given formatter.

impl Display for ByteRange

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

Formats the value using the given formatter.

impl PartialEq<ByteRange> for ByteRange

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

impl Eq for ByteRange

impl StructuralEq for ByteRange

impl StructuralPartialEq for ByteRange