Struct r3bl_rs_utils::SelectionMap

pub struct SelectionMap {
    pub map: HashMap<ChUnit, SelectionRange>,
    pub maybe_previous_direction: Option<CaretMovementDirection>,
}

Key is the row index, value is the selected range in that line (display col index range).

Note that both column indices are:

• Scroll adjusted.
• And not raw.

Fields

map: HashMap<ChUnit, SelectionRange>

maybe_previous_direction: Option<CaretMovementDirection>

Implementations

impl SelectionMap

pub fn get_caret_at_start_of_range( &self, _with: DeleteSelectionWith ) -> Option<Position>

pub fn get_selected_lines<'a>( &self, buffer: &'a EditorBuffer ) -> HashMap<ChUnit, &'a str>

pub fn get_ordered_indices(&self) -> Vec<ChUnit>

pub fn is_empty(&self) -> bool

pub fn clear(&mut self)

pub fn iter(&self) -> impl Iterator<Item = (&ChUnit, &SelectionRange)>

pub fn get(&self, row_index: ChUnit) -> Option<&SelectionRange>

pub fn has_caret_movement_direction_changed( &self, current_direction: CaretMovementDirection ) -> DirectionChangeResult

Compares the given direction (current_direction) with the maybe_previous_direction.

• If there is no existing previous direction, it returns DirectionChangeResult::DirectionIsTheSame.
• Otherwise it compares the two and returns DirectionChangeResult (whether the direction has changed or not).

pub fn insert( &mut self, row_index: ChUnit, selection_range: SelectionRange, direction: CaretMovementDirection )

pub fn remove(&mut self, row_index: ChUnit, direction: CaretMovementDirection)

pub fn update_previous_direction(&mut self, direction: CaretMovementDirection)

pub fn remove_previous_direction(&mut self)

pub fn locate_row(&self, row_index_arg: ChUnit) -> RowLocationInSelectionMap

Is there a selection range for the row_index of row_index_arg in the map?

• The map contains key value pairs of RowIndex and SelectionRange.
• So if the row_index can’t be found in the map, it means that the row is not selected, aka RowLocationInSelectionMap::Overflow.
• Otherwise it means that some range of columns in that row is selected, aka RowLocationInSelectionMap::Contained.

impl SelectionMap

pub fn to_formatted_string(&self) -> StyledContent<String>

pub fn to_unformatted_string(&self) -> String

Trait Implementations

impl Clone for SelectionMap

fn clone(&self) -> SelectionMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SelectionMap

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

Formats the value using the given formatter.

impl Default for SelectionMap

fn default() -> SelectionMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SelectionMap

fn deserialize<__D>( __deserializer: __D ) -> Result<SelectionMap, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SelectionMap

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

Formats the value using the given formatter.

impl GetSize for SelectionMap

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_size(&self) -> usize

Determines the total size of the object.

impl PartialEq for SelectionMap

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

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

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

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

impl Serialize for SelectionMap

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SelectionMap