Struct Selection

pub struct Selection { /* private fields */ }

A selection holding one or more SelRegion. Regions are kept in order from the leftmost selection to the rightmost selection.

Implementations

impl Selection

pub fn new() -> Selection

Creates a new empty Selection

pub fn caret(offset: usize) -> Selection

Creates a caret Selection, i.e. a selection with a single caret SelRegion

pub fn region(start: usize, end: usize) -> Self

Creates a region Selection, i.e. a selection with a single SelRegion from start to end position

pub fn sel_region(region: SelRegion) -> Self

Creates a Selection, with a single SelRegion equal to region.

pub fn contains(&self, offset: usize) -> bool

Returns whether this Selection, contains the given offset position or not.

Example:

let  selection = Selection::region(0, 2);
assert!(selection.contains(0));
assert!(selection.contains(1));
assert!(selection.contains(2));
assert!(!selection.contains(3));

pub fn regions(&self) -> &[SelRegion]

Returns this selection regions

pub fn regions_mut(&mut self) -> &mut [SelRegion]

Returns a mutable reference to this selection regions

pub fn min(&self) -> Selection

Returns a copy of self with all regions converted to caret region at their respective SelRegion::min offset.

Examples:

let mut selection = Selection::new();
selection.add_region(SelRegion::new(1, 3, None));
selection.add_region(SelRegion::new(6, 12, None));
selection.add_region(SelRegion::new(24, 48, None));

assert_eq!(selection.min().regions(), vec![
    SelRegion::caret(1),
    SelRegion::caret(6),
    SelRegion::caret(24)
]);

pub fn first(&self) -> Option<&SelRegion>

Get the leftmost SelRegion in this selection if present.

pub fn last(&self) -> Option<&SelRegion>

Get the rightmost SelRegion in this selection if present.

pub fn last_inserted(&self) -> Option<&SelRegion>

Get the last inserted SelRegion in this selection if present.

pub fn last_inserted_mut(&mut self) -> Option<&mut SelRegion>

Get a mutable reference to the last inserted SelRegion in this selection if present.

pub fn len(&self) -> usize

The number of SelRegion in this selection.

pub fn is_caret(&self) -> bool

A Selection is considered to be a caret if it contains only caret SelRegion (see SelRegion::is_caret)

pub fn current_caret(&self) -> Option<usize>

pub fn is_empty(&self) -> bool

Returns true if self has zero SelRegion

pub fn min_offset(&self) -> usize

Returns the minimal offset across all region of this selection.

This function panics if the selection is empty.

Example:

let mut selection = Selection::new();
selection.add_region(SelRegion::caret(4));
selection.add_region(SelRegion::new(0, 12, None));
selection.add_region(SelRegion::new(24, 48, None));
assert_eq!(selection.min_offset(), 0);

pub fn max_offset(&self) -> usize

Returns the maximal offset across all region of this selection.

This function panics if the selection is empty.

Example:

let mut selection = Selection::new();
selection.add_region(SelRegion::caret(4));
selection.add_region(SelRegion::new(0, 12, None));
selection.add_region(SelRegion::new(24, 48, None));
assert_eq!(selection.max_offset(), 48);

pub fn regions_in_range(&self, start: usize, end: usize) -> &[SelRegion]

Returns regions in self overlapping or fully enclosed in the provided start to end range.

Example:

let mut selection = Selection::new();
selection.add_region(SelRegion::new(0, 3, None));
selection.add_region(SelRegion::new(3, 6, None));
selection.add_region(SelRegion::new(7, 8, None));
selection.add_region(SelRegion::new(9, 11, None));
let regions = selection.regions_in_range(5, 10);
assert_eq!(regions, vec![
    SelRegion::new(3, 6, None),
    SelRegion::new(7, 8, None),
    SelRegion::new(9, 11, None)
]);

pub fn full_regions_in_range(&self, start: usize, end: usize) -> &[SelRegion]

Returns regions in self starting between start to end range.

Example:

let mut selection = Selection::new();
selection.add_region(SelRegion::new(0, 3, None));
selection.add_region(SelRegion::new(3, 6, None));
selection.add_region(SelRegion::new(7, 8, None));
selection.add_region(SelRegion::new(9, 11, None));
let regions = selection.full_regions_in_range(5, 10);
assert_eq!(regions, vec![
    SelRegion::new(7, 8, None),
    SelRegion::new(9, 11, None)
]);

pub fn delete_range(&mut self, start: usize, end: usize)

Deletes regions in self overlapping or enclosing in start to end range.

Example:

let mut selection = Selection::new();
selection.add_region(SelRegion::new(0, 3, None));
selection.add_region(SelRegion::new(3, 6, None));
selection.add_region(SelRegion::new(7, 8, None));
selection.add_region(SelRegion::new(9, 11, None));
selection.delete_range(5, 10);
assert_eq!(selection.regions(), vec![SelRegion::new(0, 3, None)]);

pub fn add_region(&mut self, region: SelRegion)

Add a regions to self. Note that if provided region overlap on of the selection regions they will be merged in a single region.

Example:

let mut selection = Selection::new();
// Overlapping
selection.add_region(SelRegion::new(0, 4, None));
selection.add_region(SelRegion::new(3, 6, None));
assert_eq!(selection.regions(), vec![SelRegion::new(0, 6, None)]);
// Non-overlapping
let mut selection = Selection::new();
selection.add_region(SelRegion::new(0, 3, None));
selection.add_region(SelRegion::new(3, 6, None));
assert_eq!(selection.regions(), vec![
    SelRegion::new(0, 3, None),
    SelRegion::new(3, 6, None)
]);

pub fn add_range_distinct(&mut self, region: SelRegion) -> (usize, usize)

Add a region to the selection. This method does not merge regions and does not allow ambiguous regions (regions that overlap).

On ambiguous regions, the region with the lower start position wins. That is, in such a case, the new region is either not added at all, because there is an ambiguous region with a lower start position, or existing regions that intersect with the new region but do not start before the new region, are deleted.

pub fn apply_delta( &self, delta: &RopeDelta, after: bool, drift: InsertDrift, ) -> Selection

Apply [lapce_xi_rope::RopeDelta] to this selection. Typically used to apply an edit to a buffer and update its selections Parameters:

• delta[lapce_xi_rope::RopeDelta]
• after parameter indicate if the delta should be applied before or after the selection
• drift see InsertDrift

pub fn get_cursor_offset(&self) -> usize

Returns cursor position, which corresponds to last inserted region end offset,

pub fn replace_last_inserted_region(&mut self, region: SelRegion)

Replaces last inserted SelRegion of this selection with the provided one.

Trait Implementations

impl AsRef<Selection> for Selection

fn as_ref(&self) -> &Selection

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Selection

fn clone(&self) -> Selection

Returns a copy 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 Default for Selection

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Selection

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Selection

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Selection

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Selection