Struct Selection 

pub struct Selection { /* private fields */ }

A cursor in the text buffer. This is an editing cursor, -(not a printing cursor.

Implementations

impl Selection

pub fn move_to(&mut self, idx: impl TextIndex, text: &Text)

Moves to specific, pre calculated Point.

pub fn move_hor(&mut self, by: i32, text: &Text) -> i32

Internal horizontal movement function

Returns true if the caret was moved

pub fn move_ver( &mut self, by: i32, text: &Text, area: &Area, opts: PrintOpts, ) -> bool

Internal vertical movement function.

Returns true if the caret actually moved at all.

pub fn move_ver_wrapped( &mut self, by: i32, text: &Text, area: &Area, opts: PrintOpts, ) -> bool

Internal vertical movement function.

Returns true if the caret actually moved at all.

pub fn set_anchor(&mut self)

Sets the position of the anchor to be the same as the current cursor position in the buffer

The anchor and current act as a range of text on the buffer.

pub fn unset_anchor(&mut self) -> Option<Point>

Unsets the anchor, returning its byte index if it existed

This is done so the cursor no longer has a valid selection.

pub fn swap_ends(&mut self)

Switches the position of the anchor and caret

pub fn caret(&self) -> Point

Returns the byte index of this Selection’s caret

pub fn anchor(&self) -> Option<Point>

Returns the byte index of this Selection’s anchor, if there is one

pub fn byte_range(&self, text: &Text) -> Range<usize>

Returns the byte index range between the caret and anchor

If anchor isn’t set, returns an empty range on caret.

Note

This range is inclusive, that is, it will include the character at the end. If you use it to replace a range in the Text, know that this range will be truncated to not include the last \n, since it is not allowed to be removed.

pub fn start_point(&self) -> Point

The starting Point of this Selection

pub fn end_point(&self, text: &Text) -> Point

The ending Point of this Selection

pub fn point_range(&self, text: &Text) -> Range<Point>

Returns the range between caret and anchor.

If anchor isn’t set, returns a range that contains only the caret’s current char.

pub fn point_range_excl(&self) -> Range<Point>

Returns an exclusive range between caret and anchor

If anchor isn’t set, both Points will be the same.

pub fn set_desired_cols(&mut self, v: usize, w: usize)

Sets both the desired visual column, as well as the desired wrapped column

pub fn v_caret(&self, text: &Text, area: &Area, opts: PrintOpts) -> VPoint

The visual caret of this Selection

VPoints include a lot more information than regular Points, like visual distance form the left edge, what the desired distance is, etc.

pub fn v_anchor( &self, text: &Text, area: &Area, opts: PrintOpts, ) -> Option<VPoint>

The visual anchor of this Selection, if it exists

VPoints include a lot more information than regular Points, like visual distance form the left edge, what the desired distance is, etc.

pub fn v_range(&self, text: &Text, area: &Area, opts: PrintOpts) -> [VPoint; 2]

The visual range between the caret and anchor of this Selection

VPoints include a lot more information than regular Points, like visual distance form the left edge, what the desired distance is, etc.

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for Selection

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Clone for Selection

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Selection

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for Selection

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for Selection

fn default() -> Selection

Returns the “default value” for a type.

impl Encode for Selection

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.