Struct kaolinite::map::CharMap

pub struct CharMap {
    pub map: HashMap<usize, Vec<(usize, usize)>>,
}

Keeps notes of specific characters within a document for the purposes of double width and tab characters, which have display widths different to that of their character width

Fields

map: HashMap<usize, Vec<(usize, usize)>>

Implementations

impl CharMap

pub fn new(map: HashMap<usize, Vec<(usize, usize)>>) -> Self

Create a new character map

pub fn add(&mut self, idx: usize, val: (usize, usize))

Add a value to a line in the map

pub fn insert(&mut self, idx: usize, slice: Vec<(usize, usize)>)

Add a line to the map

pub fn delete(&mut self, idx: usize)

Delete a line from the map

pub fn get(&self, idx: usize) -> Option<&Vec<(usize, usize)>>

Get a line from the map

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

Verify whether this line is in the map

pub fn splice(&mut self, loc: &Loc, start: usize, slice: Vec<(usize, usize)>)

Add a slice to the map

pub fn shift_insertion( &mut self, loc: &Loc, st: &str, tab_width: usize ) -> usize

Shift entries up in the character map

pub fn shift_deletion( &mut self, loc: &Loc, x: (usize, usize), st: &str, tab_width: usize )

Shift entries down in the character map

pub fn shift_up(&mut self, loc: usize)

Shift lines in the character map up one

pub fn shift_down(&mut self, loc: usize)

Shift lines in the character map down one

pub fn count(&self, loc: &Loc, display: bool) -> Option<usize>

Count the number of characters before an index, useful for conversion of indices

Trait Implementations

impl Clone for CharMap

fn clone(&self) -> CharMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CharMap

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

Formats the value using the given formatter.

impl Default for CharMap

fn default() -> CharMap

Returns the “default value” for a type.

impl PartialEq for CharMap

fn eq(&self, other: &CharMap) -> 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 Eq for CharMap

impl StructuralPartialEq for CharMap