Struct conrod_core::text::cursor::Index

pub struct Index {
    pub line: usize,
    pub char: usize,
}

An index representing the position of a cursor within some text.

Fields

line: usize

The index of the line upon which the cursor is situated.

char: usize

The index within all possible cursor positions for the line.

For example, for the line foo, a char of 1 would indicate the cursor's position as f|oo where | is the cursor.

Implementations

impl Index

pub fn previous_word_start<I>(self, text: &str, line_infos: I) -> Option<Self> where
    I: Iterator<Item = Info>, 

The cursor index of the beginning of the word (block of non-whitespace) before self.

If self is at the beginning of the line, call previous, which returns the last index position of the previous line, or None if it's the first line

If self points to whitespace, skip past that whitespace, then return the index of the start of the word that precedes the whitespace

If self is in the middle or end of a word, return the index of the start of that word

pub fn next_word_end<I>(self, text: &str, line_infos: I) -> Option<Self> where
    I: Iterator<Item = Info>, 

The cursor index of the end of the first word (block of non-whitespace) after self.

If self is at the end of the text, this returns None.

If self is at the end of a line other than the last, this returns the first index of the next line.

If self points to whitespace, skip past that whitespace, then return the index of the end of the word after the whitespace

If self is in the middle or start of a word, return the index of the end of that word

pub fn previous<I>(self, line_infos: I) -> Option<Self> where
    I: Iterator<Item = Info>, 

The cursor index that comes before self.

If self is at the beginning of the text, this returns None.

If self is at the beginning of a line other than the first, this returns the last index position of the previous line.

If self is a position other than the start of a line, it will return the position that is immediately to the left.

pub fn next<I>(self, line_infos: I) -> Option<Self> where
    I: Iterator<Item = Info>, 

The cursor index that follows self.

If self is at the end of the text, this returns None.

If self is at the end of a line other than the last, this returns the first index of the next line.

If self is a position other than the end of a line, it will return the position that is immediately to the right.

pub fn clamp_to_lines<I>(self, line_infos: I) -> Self where
    I: Iterator<Item = Info>, 

Clamps self to the given lines.

If self would lie after the end of the last line, return the index at the end of the last line.

If line_infos is empty, returns cursor at line=0 char=0.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Index

impl Debug for Index

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

Formats the value using the given formatter.

impl Eq for Index

impl Ord for Index

fn cmp(&self, other: &Index) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<Index> for Index

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

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

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

This method tests for !=.

impl PartialOrd<Index> for Index

fn partial_cmp(&self, other: &Index) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Index) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Index) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Index) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Index) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Index

impl StructuralPartialEq for Index