Struct conrod::text::cursor::Index
[−]
[src]
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.
Methods
impl Index
[src]
pub fn previous_word_start<I>(self, text: &str, line_infos: I) -> Option<Self> where
I: Iterator<Item = Info>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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>,
[src]
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 Copy for Index
[src]
impl Clone for Index
[src]
fn clone(&self) -> Index
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl Debug for Index
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl PartialEq for Index
[src]
fn eq(&self, __arg_0: &Index) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &Index) -> bool
[src]
This method tests for !=
.
impl Eq for Index
[src]
impl PartialOrd for Index
[src]
fn partial_cmp(&self, __arg_0: &Index) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &Index) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &Index) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &Index) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &Index) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for Index
[src]
fn cmp(&self, __arg_0: &Index) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more