Skip to main content

IndexMap

Struct IndexMap 

Source
pub struct IndexMap { /* private fields */ }
Expand description

The map between the two index spaces of TextPage.

A table of segments, not an index: it converts a character index into a text offset and back, so a caller never has to guess which of the two sequences a number counts in.

Implementations§

Source§

impl IndexMap

Source

pub fn segments(&self) -> &[CharSegment]

The segments, oldest first.

Source

pub fn text_len(&self) -> usize

How many characters the text holds.

Source

pub fn char_index(&self, text_index: TextIndex) -> Option<CharIndex>

The character index a text offset names.

let map = IndexMap::default();
assert_eq!(map.char_index(TextIndex::new(0)), None);
Source

pub fn text_index(&self, char_index: CharIndex) -> Option<TextIndex>

The text offset a character index names, or None for a character the text does not hold.

Source

pub fn text_index_at_or_after(&self, char_index: CharIndex) -> Option<TextIndex>

The text offset a character index names, rounded forward to the next character the text does hold.

What a start bound wants: a request that begins on a stripped character should begin at the next real one rather than failing.

Source

pub fn text_index_end(&self, char_index: CharIndex) -> TextIndex

The text offset one past the last text character at or before char_index, which is what an end bound wants.

Trait Implementations§

Source§

impl Clone for IndexMap

Source§

fn clone(&self) -> IndexMap

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IndexMap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for IndexMap

Source§

fn default() -> IndexMap

Returns the “default value” for a type. Read more
Source§

impl Eq for IndexMap

Source§

impl PartialEq for IndexMap

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for IndexMap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.