Struct text_unit::TextRange

pub struct TextRange { /* fields omitted */ }

A range in the text, represented as a pair of TextUnits.

Panics

Slicing a &str with TextRange panics if the result is not a valid utf8 string.

Methods

impl TextRange

pub fn from_to(from: TextUnit, to: TextUnit) -> TextRange

The left-inclusive range ([from..to)) between to points in the text

pub fn offset_len(offset: TextUnit, len: TextUnit) -> TextRange

The left-inclusive range ([offset..offset + len)) between to points in the text

pub fn start(&self) -> TextUnit

The inclusive start of this range

pub fn end(&self) -> TextUnit

The exclusive end of this range

pub fn len(&self) -> TextUnit

The length of this range

pub fn is_empty(&self) -> bool

Is this range empty of any content?

pub fn is_subrange(&self, other: &TextRange) -> bool

pub fn intersection(&self, other: &TextRange) -> Option<TextRange>

pub fn extend_to(&self, other: &TextRange) -> TextRange

The smallest range that contains both ranges

pub fn contains(&self, offset: TextUnit) -> bool

pub fn contains_inclusive(&self, offset: TextUnit) -> bool

pub fn checked_sub(self, other: TextUnit) -> Option<TextRange>

Trait Implementations

impl<'a> Add<&'a TextUnit> for TextRange

type Output = TextRange

The resulting type after applying the + operator.

fn add(self, rhs: &'a TextUnit) -> TextRange

Performs the + operation.

impl<'a, 'b> Add<&'a TextUnit> for &'b TextRange

type Output = TextRange

The resulting type after applying the + operator.

fn add(self, rhs: &'a TextUnit) -> TextRange

Performs the + operation.

impl Add<TextUnit> for TextRange

type Output = TextRange

The resulting type after applying the + operator.

fn add(self, rhs: TextUnit) -> TextRange

Performs the + operation.

impl<'a> Add<TextUnit> for &'a TextRange

type Output = TextRange

The resulting type after applying the + operator.

fn add(self, rhs: TextUnit) -> TextRange

Performs the + operation.

impl<'a> AddAssign<&'a TextUnit> for TextRange

fn add_assign(&mut self, rhs: &'a TextUnit)

Performs the += operation.

impl AddAssign<TextUnit> for TextRange

fn add_assign(&mut self, rhs: TextUnit)

Performs the += operation.

impl Clone for TextRange

fn clone(&self) -> TextRange

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for TextRange

impl Debug for TextRange

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

Formats the value using the given formatter.

impl Display for TextRange

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

Formats the value using the given formatter.

impl Eq for TextRange

impl Hash for TextRange

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, 

Feeds a slice of this type into the given [Hasher].

impl Index<TextRange> for str

type Output = str

The returned type after indexing.

fn index(&self, index: TextRange) -> &str

Performs the indexing (container[index]) operation.

impl Index<TextRange> for String

type Output = str

The returned type after indexing.

fn index(&self, index: TextRange) -> &str

Performs the indexing (container[index]) operation.

impl PartialEq<TextRange> for TextRange

fn eq(&self, other: &TextRange) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &TextRange) -> bool

This method tests for !=.

impl RangeBounds<TextUnit> for TextRange

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

Start index bound.

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

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.

impl StructuralEq for TextRange

impl StructuralPartialEq for TextRange

impl<'a> Sub<&'a TextUnit> for TextRange

type Output = TextRange

The resulting type after applying the - operator.

fn sub(self, rhs: &'a TextUnit) -> TextRange

Performs the - operation.

impl<'a, 'b> Sub<&'a TextUnit> for &'b TextRange

type Output = TextRange

The resulting type after applying the - operator.

fn sub(self, rhs: &'a TextUnit) -> TextRange

Performs the - operation.

impl Sub<TextUnit> for TextRange

type Output = TextRange

The resulting type after applying the - operator.

fn sub(self, rhs: TextUnit) -> TextRange

Performs the - operation.

impl<'a> Sub<TextUnit> for &'a TextRange

type Output = TextRange

The resulting type after applying the - operator.

fn sub(self, rhs: TextUnit) -> TextRange

Performs the - operation.

impl<'a> SubAssign<&'a TextUnit> for TextRange

fn sub_assign(&mut self, rhs: &'a TextUnit)

Performs the -= operation.

impl SubAssign<TextUnit> for TextRange

fn sub_assign(&mut self, rhs: TextUnit)

Performs the -= operation.