Struct ra_ap_syntax::TextRange [−]
pub struct TextRange { /* fields omitted */ }
Expand description
A range in text, represented as a pair of TextSize
.
It is a logic error for start
to be greater than end
.
Implementations
impl TextRange
impl TextRange
Creates a new TextRange
with the given start
and end
(start..end
).
Panics
Panics if end < start
.
Examples
let start = TextSize::from(5); let end = TextSize::from(10); let range = TextRange::new(start, end); assert_eq!(range.start(), start); assert_eq!(range.end(), end); assert_eq!(range.len(), end - start);
Create a new TextRange
with the given offset
and len
(offset..offset + len
).
Examples
let text = "0123456789"; let offset = TextSize::from(2); let length = TextSize::from(5); let range = TextRange::at(offset, length); assert_eq!(range, TextRange::new(offset, offset + length)); assert_eq!(&text[range], "23456")
Create a zero-length range at the specified offset (offset..offset
).
Examples
let point: TextSize; let range = TextRange::empty(point); assert!(range.is_empty()); assert_eq!(range, TextRange::new(point, point));
impl TextRange
impl TextRange
Identity methods.
impl TextRange
impl TextRange
Manipulation methods.
Check if this range contains an offset.
The end index is considered excluded.
Examples
let (start, end): (TextSize, TextSize); let range = TextRange::new(start, end); assert!(range.contains(start)); assert!(!range.contains(end));
pub fn contains_inclusive(self, offset: TextSize) -> bool
pub fn contains_inclusive(self, offset: TextSize) -> bool
Check if this range contains an offset.
The end index is considered included.
Examples
let (start, end): (TextSize, TextSize); let range = TextRange::new(start, end); assert!(range.contains_inclusive(start)); assert!(range.contains_inclusive(end));
pub fn contains_range(self, other: TextRange) -> bool
pub fn contains_range(self, other: TextRange) -> bool
Check if this range completely contains another range.
Examples
let larger = TextRange::new(0.into(), 20.into()); let smaller = TextRange::new(5.into(), 15.into()); assert!(larger.contains_range(smaller)); assert!(!smaller.contains_range(larger)); // a range always contains itself assert!(larger.contains_range(larger)); assert!(smaller.contains_range(smaller));
The range covered by both ranges, if it exists. If the ranges touch but do not overlap, the output range is empty.
Examples
assert_eq!( TextRange::intersect( TextRange::new(0.into(), 10.into()), TextRange::new(5.into(), 15.into()), ), Some(TextRange::new(5.into(), 10.into())), );
Extends the range to cover other
as well.
Examples
assert_eq!( TextRange::cover( TextRange::new(0.into(), 5.into()), TextRange::new(15.into(), 20.into()), ), TextRange::new(0.into(), 20.into()), );
pub fn cover_offset(self, offset: TextSize) -> TextRange
pub fn cover_offset(self, offset: TextSize) -> TextRange
Extends the range to cover other
offsets as well.
Examples
assert_eq!( TextRange::empty(0.into()).cover_offset(20.into()), TextRange::new(0.into(), 20.into()), )
pub fn checked_add(self, offset: TextSize) -> Option<TextRange>
pub fn checked_add(self, offset: TextSize) -> Option<TextRange>
Add an offset to this range.
Note that this is not appropriate for changing where a TextRange
is
within some string; rather, it is for changing the reference anchor
that the TextRange
is measured against.
The unchecked version (Add::add
) will always panic on overflow,
in contrast to primitive integers, which check in debug mode only.
pub fn checked_sub(self, offset: TextSize) -> Option<TextRange>
pub fn checked_sub(self, offset: TextSize) -> Option<TextRange>
Subtract an offset from this range.
Note that this is not appropriate for changing where a TextRange
is
within some string; rather, it is for changing the reference anchor
that the TextRange
is measured against.
The unchecked version (Sub::sub
) will always panic on overflow,
in contrast to primitive integers, which check in debug mode only.
Relative order of the two ranges (overlapping ranges are considered equal).
This is useful when, for example, binary searching an array of disjoint ranges.
Examples
let a = TextRange::new(0.into(), 3.into()); let b = TextRange::new(4.into(), 5.into()); assert_eq!(a.ordering(b), Ordering::Less); let a = TextRange::new(0.into(), 3.into()); let b = TextRange::new(3.into(), 5.into()); assert_eq!(a.ordering(b), Ordering::Less); let a = TextRange::new(0.into(), 3.into()); let b = TextRange::new(2.into(), 5.into()); assert_eq!(a.ordering(b), Ordering::Equal); let a = TextRange::new(0.into(), 3.into()); let b = TextRange::new(2.into(), 2.into()); assert_eq!(a.ordering(b), Ordering::Equal); let a = TextRange::new(2.into(), 3.into()); let b = TextRange::new(2.into(), 2.into()); assert_eq!(a.ordering(b), Ordering::Greater);
Trait Implementations
pub fn add_assign(&mut self, rhs: A)
pub fn add_assign(&mut self, rhs: A)
Performs the +=
operation. Read more
impl RangeBounds<TextSize> for TextRange
impl RangeBounds<TextSize> for TextRange
pub fn start_bound(&self) -> Bound<&TextSize>
pub fn start_bound(&self) -> Bound<&TextSize>
Start index bound. Read more
1.35.0[src]fn contains<U>(&self, item: &U) -> bool where
T: PartialOrd<U>,
U: PartialOrd<T> + ?Sized,
fn contains<U>(&self, item: &U) -> bool where
T: PartialOrd<U>,
U: PartialOrd<T> + ?Sized,
Returns true
if item
is contained in the range. Read more
pub fn sub_assign(&mut self, rhs: S)
pub fn sub_assign(&mut self, rhs: S)
Performs the -=
operation. Read more
impl StructuralEq for TextRange
impl StructuralPartialEq for TextRange
Auto Trait Implementations
impl RefUnwindSafe for TextRange
impl UnwindSafe for TextRange
Blanket Implementations
Mutably borrows from an owned value. Read more
Compare self to key
and return true
if they are equal.