Struct gll::runtime::Range

pub struct Range<'i>(pub Range<'i>);

Tuple Fields

0: Range<'i>

Implementations

impl<'i> Range<'i>

pub fn subtract_suffix(self, other: Self) -> Self

Methods from Deref<Target = Range<'i>>

pub fn len(&self) -> usize

Return the length of the range.

pub fn is_empty(&self) -> bool

Return true if the range is empty.

pub fn nonempty(&self) -> Result<Range<'id, NonEmpty>, IndexingError>

Try to create a proof that the Range is nonempty; return a Result where the Ok branch carries a non-empty Range.

pub fn start(&self) -> usize

Return the start index.

pub fn end(&self) -> usize

Return the end index.

pub fn split_at(
    &self,
    index: usize
) -> (Range<'id, Unknown>, Range<'id, Unknown>, bool)

Split to length index; if past the end, return false and clamp to the end

index is a relative index.

pub fn contains(&self, abs_index: usize) -> Option<Index<'id, NonEmpty>>

abs_index is an absolute index

pub fn subdivide(&self, n: usize) -> Subdivide<'id>

Return an iterator that divides the range in n parts, in as even length chunks as possible.

pub fn join<Q>(
    &self,
    other: Range<'id, Q>
) -> Result<Range<'id, <(P, Q) as ProofAdd>::Sum>, IndexingError>where
    (P, Q): ProofAdd,

Join together two adjacent ranges (they must be exactly touching, and in left to right order).

pub fn join_cover<Q>(
    &self,
    other: Range<'id, Q>
) -> Range<'id, <(P, Q) as ProofAdd>::Sum>where
    (P, Q): ProofAdd,

Extend the range to the end of other, including any space in between

pub fn join_cover_both<Q>(
    &self,
    other: Range<'id, Q>
) -> Range<'id, <(P, Q) as ProofAdd>::Sum>where
    (P, Q): ProofAdd,

Extend the range to start and end of other, including any space in between

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

pub fn frontiers(&self) -> (Range<'id, Unknown>, Range<'id, Unknown>)

Return two empty ranges, at the front and the back of the range respectively

pub fn forward_by(&self, index: &mut Index<'id, NonEmpty>, offset: usize) -> bool

Increment index, if doing so would still be before the end of the range

Return true if the index was incremented.

pub fn forward_range_by<Q>(
    &self,
    r: Range<'id, Q>,
    offset: usize
) -> Range<'id, Unknown>

Increment r, clamping to the end of self.

pub fn no_proof(&self) -> Range<'id, Unknown>

pub fn first(&self) -> Index<'id, P>

Return the first index in the range (The index is accessible if the range is NonEmpty).

pub fn upper_middle(&self) -> Index<'id, P>

Return the middle index, rounding up.

Produces mid where mid = start + len / 2.

pub fn lower_middle(&self) -> Index<'id, NonEmpty>

Return the middle index, rounding down.

Produces mid where mid = start + (len - 1)/ 2.

pub fn last(&self) -> Index<'id, NonEmpty>

pub fn init(&self) -> Range<'id, Unknown>

pub fn advance_(&self) -> Result<Range<'id, NonEmpty>, IndexingError>

Trait Implementations

impl<'i> Clone for Range<'i>

fn clone(&self) -> Range<'i>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'i> Debug for Range<'i>

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

Formats the value using the given formatter.

impl<'i> Deref for Range<'i>

type Target = Range<'i, Unknown>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'i> Hash for Range<'i>

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<'i> Ord for Range<'i>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'i> PartialEq<Range<'i>> for Range<'i>

fn eq(&self, other: &Range<'i>) -> 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<'i> PartialOrd<Range<'i>> for Range<'i>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'i> Copy for Range<'i>

impl<'i> Eq for Range<'i>

impl<'i> StructuralEq for Range<'i>

impl<'i> StructuralPartialEq for Range<'i>