Struct Selections

pub struct Selections { /* private fields */ }

The list of Selections in a Text

This list can contain any number of Selections, and they should be usable in whatever order the end user may want, without breaking from, for example, modifications that should move cursors backwards or ahead. If that is not the case, report it as a bug.

they are primarily meant to be interacted with from the Handle, with its edit_ methods meant to efficiently handle a large number of Selections in an efficient manner, although you can interact with them separately.

A Text will keep itself in check with regards to its Selections, that is, it will automatically remove and add the MainCaret and ExtraCaret tags when the Selections are altered. If it fails to do that, report it as a bug.

Implementations

impl Selections

pub fn new() -> Self

Returns a new Selections

pub fn set_main(&mut self, new: usize)

Sets the main Selection

pub fn rotate_main(&mut self, amount: i32)

Rotates the main Selection by an amount

pub fn clear(&mut self)

Removes all Selections

pub fn reset(&mut self)

Removes all Selections and adds a default Selection as main

pub fn remove_extras(&mut self)

Removes all but the main Selection

pub fn get_main(&self) -> Option<&Selection>

Gets the main Selection, if there is one

pub fn get(&self, n: usize) -> Option<&Selection>

Gets the nth Selection if there is one

pub fn iter(&self) -> impl Iterator<Item = (&Selection, bool)>

Iterates over all Selections in order

pub fn main_index(&self) -> usize

The index of the main Selection

pub fn len(&self) -> usize

How many Selections there are in the list

pub fn is_empty(&self) -> bool

Returns true when there are no Selections

Trait Implementations

impl Clone for Selections

fn clone(&self) -> Selections

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Selections

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

Formats the value using the given formatter.

impl Default for Selections

fn default() -> Self

Returns the “default value” for a type.