Struct Ranges 

pub struct Ranges { /* private fields */ }

A list of non intersecting exclusive Range<usize>s

The primary purpose of this struct is to serve parsers by telling Duat which ranges need to be updated. This lets Duat minimize as much as possible the amount of work done to update the Text when it changes in a Buffer.

Implementations

impl Ranges

pub fn new(range: Range<usize>) -> Self

Return a new instance of Ranges with an initial Range

pub const fn empty() -> Self

Returns a new empty Ranges

pub fn set_min_len(&mut self, min: usize)

Sets a minimum length to keep Ranges

pub fn add(&mut self, new: Range<usize>) -> bool

Adds a range to the list of Range<usize>s

This range will be merged in with the others on the list, so it may bridge gaps between ranges or for longer ranges within, without allowing for the existance of intersecting ranges.

This function will return true if the Ranges were changed by this addition.

pub fn extend(&mut self, ranges: impl IntoIterator<Item = Range<usize>>) -> bool

Adds many Ranges to be merged with the existing ones

This function will return true if the Ranges were changed by this addition.

pub fn remove_on( &mut self, within: Range<usize>, ) -> impl Iterator<Item = Range<usize>>

Removes a Range from the list, returning an Iterator over the Ranges that were taken

pub fn remove_intersecting( &mut self, within: Range<usize>, ) -> impl Iterator<Item = Range<usize>>

Removes all Ranges that intersect with the given one, returning an Iterator over them

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

Applies the add function to another Rangess

pub fn shift_by(&mut self, from: usize, shift: i32)

Shifts the Ranges within by a Change

If the diff is negative (i.e. a part of the ranges were removed), then ranges will be removed ahead of from accordingly.

pub fn len(&self) -> usize

Returns the number of Range<usize>s

pub fn is_empty(&self) -> bool

Returns true if there are no Range<usize>s

pub fn iter(&self) -> impl Iterator<Item = Range<usize>>

An Iterator over the Ranges in this list

pub fn iter_over( &self, within: Range<usize>, ) -> impl Iterator<Item = Range<usize>>

The same as Ranges::remove_on, but without removing, just iterating over the relevant ranges

This method will trim the iterated Ranges to the bounds of within. If you want a non trimmed version of this method, check out iter_intersecting.

pub fn iter_intersecting( &self, within: Range<usize>, ) -> impl Iterator<Item = Range<usize>>

Iterates over all Ranges that intersect with within

If you want to automatically trim those ranges to the bounds of within, check out iter_over. If you want to remove the ranges that intersect with the given one, see, Ranges::remove_intersecting

pub fn intersects_with(&self, range: Range<usize>) -> bool

Wether any Range in this Ranges intersects with the given range

Trait Implementations

impl Clone for Ranges

fn clone(&self) -> Ranges

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ranges

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

Formats the value using the given formatter.

impl Default for Ranges

fn default() -> Ranges

Returns the “default value” for a type.

impl IntoIterator for Ranges

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

type Item = Range<usize>

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Ranges

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Ranges

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 PartialOrd for Ranges

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Ranges