Struct textpos::TextRange

pub struct TextRange { /* private fields */ }

Defines a range in a text.

A range is defined by two TextPositions: base and next. base is the first character (ie. inclusive) and next is just outside of the range (ie. exclusive).

This graphic shows how they work:

          Range
       ___________
   L o r e m   i p s u m
       -           -
       |           |
       |           |
     base         next

(in this example, the range would be “rem ip”)

Note that due to this, the character at next may not actually exist.

Implementations

impl TextRange

pub fn new(base: TextPosition, next: TextPosition) -> Self

Create a new text range with base as the first character (inclusive) and next after the last character (exclusive).

They may point to the same location (in which case the range is empty), but next may not be smaller than base.

See also the documentation on TextPosition for the roles of base and next.

pub fn new_empty(pos: TextPosition) -> Self

Create a new empty range at pos.

pub fn inc_col(&mut self)

Append a non-newline character to the range.

pub fn inc_line(&mut self)

Append a newline character to the range.

pub fn merge(&mut self, other: TextRange)

Merge other into self.

self must be immediately before other. This means there may not be any characters between self.last() and other.first(), but the latter must still be after the former.

pub fn begin_next_range(&self) -> Self

Create a new empty range immediately after self.

pub fn base(&self) -> &TextPosition

Get the base character position

pub fn next(&self) -> &TextPosition

Get the next character position

pub fn len(&self) -> usize

The number of characters contained in the range

Trait Implementations

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 Debug for TextRange

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

Formats the value using the given formatter.

impl Default for TextRange

fn default() -> TextRange

Returns the “default value” for a type.

impl Display for TextRange

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

Formats the value using the given formatter.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TextRange

impl StructuralEq for TextRange

impl StructuralPartialEq for TextRange