Struct TextRange

pub struct TextRange {
    pub start: usize,
    pub end: usize,
}

a half-open interval in ℕ, [start, end)

Fields

start: usize

end: usize

Implementations

impl TextRange

pub fn new(start: usize, end: usize) -> Self

caller should check that start < end

pub fn new_valid(start: usize, end: usize) -> Option<Self>

Creates a new TextRange only if start < end (non-empty interval). Returns None if start >= end.

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

pub fn empty(&self) -> bool

pub fn contains(&self, pos: usize) -> bool

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

Determines the strict ordering relationship between two ranges.

Returns Some(Ordering::Less) if this range is completely before the other range. Returns Some(Ordering::Greater) if this range is completely after the other range. Returns None if the ranges overlap.

Examples

use std::cmp::Ordering;
use interval_tree::TextRange;

let a = TextRange::new(0, 5);
let b = TextRange::new(6, 10);
assert_eq!(a.strict_order(&b), Some(Ordering::Less));

let c = TextRange::new(7, 8);
assert_eq!(c.strict_order(&b), None);

pub fn split_at(&mut self, position: usize, left: bool) -> Self

split self, return the split out interval. if left is true, the left part is split out and returned. This function does not check whether position is valid.

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

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

pub fn intersection(&self, other: impl Into<Self>) -> Option<Self>

pub fn advance(&mut self, offset: usize)

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

Trait Implementations

impl Clone for TextRange

fn clone(&self) -> TextRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextRange

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

Formats the value using the given formatter.

impl<T: Into<usize>> From<(T, T)> for TextRange

fn from((start, end): (T, T)) -> Self

Converts to this type from the input type.

impl<T: Into<usize>> From<Range<T>> for TextRange

fn from(range: Range<T>) -> Self

Converts to this type from the input type.

impl Ord for TextRange

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 TextRange

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

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 RangeBounds<usize> for TextRange

fn start_bound(&self) -> Bound<&usize>

Start index bound.

fn end_bound(&self) -> Bound<&usize>

End index bound.

fn contains<U>(&self, item: &U) -> bool

where T: PartialOrd<U>, U: PartialOrd<T> + ?Sized,

Returns true if item is contained in the range.

fn is_empty(&self) -> bool

where T: PartialOrd,

🔬This is a nightly-only experimental API. (range_bounds_is_empty)

Returns true if the range contains no items. One-sided ranges (RangeFrom, etc) always return false.

impl Copy for TextRange

impl Eq for TextRange

impl StructuralPartialEq for TextRange