Struct Range

pub struct Range<T = ()> {
    pub offset: usize,
    pub length: usize,
    pub data: T,
}

A representation of a range

The type parameter is used to wrap data related to the range.

Fields

offset: usize

The range offset

length: usize

The range length

data: T

The data described within the range.

Implementations

impl Range

pub fn new(offset: usize, length: usize) -> Range

Creates a new Range

pub fn wrap<T>(self, data: T) -> Range<T>

Wraps some data in the range.

pub fn empty(offset: usize) -> Range

Creates an empty range with an offset.

pub fn shrink_n(&self, n: usize) -> Option<Range>

Shrinks range at both ends with n items.

pub fn shrink(&self) -> Option<Range>

Shrinks range at both ends with 1 item.

pub fn intersect(&self, other: &Range) -> Option<Range>

Intersects a range with another, where ends are excluded.

pub fn ends_intersect(&self, other: &Range) -> Option<Range>

Intersects a range with another, where ends are included.

impl<T> Range<T>

pub fn is_empty(&self) -> bool

Returns true if range is empty

pub fn next_offset(&self) -> usize

Returns the next offset

pub fn iter(&self) -> Range<usize>

Returns a range iterator.

pub fn map<U, F: FnOnce(T) -> U>(self, f: F) -> Range<U>

Maps from some data to another.

pub fn range(&self) -> Range

Returns range information without the data.

pub fn unwrap(self) -> T

Unwraps the data.

pub fn decouple(self) -> (Range, T)

Decouples range and data.

Trait Implementations

impl<T: Clone> Clone for Range<T>

fn clone(&self) -> Range<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Range<T>

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

Formats the value using the given formatter.

impl<T> From<(Range, T)> for Range<T>

fn from((r, d): (Range, T)) -> Range<T>

Converts to this type from the input type.

impl<T: Hash> Hash for Range<T>

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<T: PartialEq> PartialEq for Range<T>

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

impl<T: Eq> Eq for Range<T>

impl<T> StructuralPartialEq for Range<T>