Struct modalkit::editing::rope::EditRope

pub struct EditRope { /* private fields */ }

A rope with context-aware movements and high-level operations.

Implementations

impl EditRope

pub fn empty() -> EditRope

Create an empty, zero-length rope.

pub fn write_to<T: Write>(&self, writer: T) -> Result<(), Error>

Write the contents of the EditRope to a writer.

pub fn split( &self, CharOff: CharOff, CharOff: CharOff, inclusive: bool ) -> (EditRope, EditRope, EditRope)

Split the rope into three different parts.

pub fn trim_start(&self) -> EditRope

Remove leading whitespace from the rope.

pub fn trim_end(&self) -> EditRope

Remove trailing whitespace from the rope.

pub fn trim_start_matches<F>(&self, matches: F) -> EditRope

where F: Fn(char) -> bool,

Remove matching leading characters from the rope.

pub fn trim_end_matches<F>(&self, matches: F) -> EditRope

where F: Fn(char) -> bool,

Remove matching trailing characters from the rope.

pub fn trim(&self) -> EditRope

Remove whitespace from the start and end of the rope.

pub fn slice<R: RangeBounds<CharOff>>(&self, range: R) -> EditRope

Returns a slice of a range within the rope.

pub fn replace<R: RangeBounds<CharOff>>( &mut self, range: R, substitution: EditRope ) -> (CursorChoice, Vec<CursorAdjustment>)

Replace a range within the rope with some new text.

pub fn repeat(&self, shape: TargetShape, times: usize) -> EditRope

Return the rope repeated n times.

pub fn transform( &self, start: CharOff, end: CharOff, inclusive: bool, f: impl Fn(EditRope) -> EditRope ) -> EditRope

Transform a range within the rope with function f, and return the updated version.

pub fn changecase(&self, case: &Case) -> EditRope

Change the case of this rope.

pub fn insert( &mut self, cursor: &Cursor, dir: MoveDir1D, text: EditRope, style: InsertStyle ) -> (CursorChoice, Vec<CursorAdjustment>)

Insert or replace text before or after a given cursor position.

pub fn paste( &mut self, cursor: &Cursor, dir: MoveDir1D, text: EditRope, shape: TargetShape ) -> (CursorChoice, Vec<CursorAdjustment>)

Paste text at a given cursor position.

pub fn trailing_newline(&mut self)

Mutably force this rope to contain a trailing newline if it doesn’t already.

pub fn get_line(&self, line: usize) -> Option<EditRope>

Get the text for a line.

pub fn get_char_at_cursor(&self, cursor: &Cursor) -> Option<char>

Returns the character (if it exists) at a given cursor position.

pub fn is_blank(&self) -> bool

Returns true if this rope contains only whitespace characters.

pub fn is_blank_line(&self, line: usize) -> bool

Returns true if a line contains only whitespace characters.

pub fn is_blank_range(&self, start: CharOff, end: CharOff) -> bool

Returns true if the inclusive range of bytes contains only whitespace characters.

pub fn len_offset(&self) -> CharOff

Return the length in number of characters as a CharOff.

pub fn len(&self) -> usize

Return the length in number of characters.

pub fn is_empty(&self) -> bool

Indicates whether or not this rope is empty (contains no characters).

pub fn get_lines(&self) -> usize

Return the number of lines in this rope.

pub fn line_after(&self, line: usize) -> Option<CharOff>

Get the character offset of the start of the following line.

pub fn get_columns(&self, line: usize) -> usize

Return the number of columns on the given line.

pub fn line_of_offset(&self, off: CharOff) -> usize

Return the line number of the given character offset.

pub fn offset_of_line(&self, line: usize) -> CharOff

Return the character offset of the start of a given line.

pub fn offset_to_cursor(&self, off: CharOff) -> Cursor

Convert a character offset to a Cursor.

pub fn cursor_to_offset(&self, cursor: &Cursor) -> CharOff

Convert a cursor to a character offset.

pub fn first(&self) -> Cursor

Return a cursor located at the first character in the rope.

pub fn last_offset(&self) -> CharOff

Return the last character offset in the rope.

pub fn last(&self) -> Cursor

Return a cursor located at the last character in the rope.

pub fn diff(&self, other: &EditRope) -> Vec<CursorAdjustment>

Compare this rope with a new version, and return a vector of adjustments needed to fix cursors and marks when moving to the new version.

pub fn newlines(&self, offset: CharOff) -> NewlineIterator<'_>

Returns an iterator over the newlines within this rope following offset.

pub fn chars(&self, pos: CharOff) -> CharacterIterator<'_>

Returns an iterator over the characters within this rope following position.

pub fn chars_until(&self, pos: CharOff, end: CharOff) -> CharacterIterator<'_>

Returns an iterator over the characters within this rope following position.

pub fn get_prefix_word_mut( &self, cursor: &mut Cursor, style: &WordStyle ) -> Option<Self>

Get the text before the cursor, and update the cursor to point to its start.

pub fn get_prefix_word( &self, cursor: &Cursor, style: &WordStyle ) -> Option<Self>

Get the text before the cursor.

pub fn get_cursor_word_mut( &self, cursor: &mut Cursor, style: &WordStyle ) -> Option<Self>

Returns the word underneath the Cursor, and updates it to point at the beginning of the word.

If the cursor is not positioned over a word, this will search for the next word in the text.

pub fn get_cursor_word( &self, cursor: &Cursor, style: &WordStyle ) -> Option<Self>

Returns the word underneath the Cursor.

If the cursor is not positioned over a word, this will search for the next word in the text.

Trait Implementations

impl Add for EditRope

type Output = EditRope

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl AddAssign for EditRope

fn add_assign(&mut self, rhs: EditRope)

Performs the += operation.

impl Clone for EditRope

fn clone(&self) -> EditRope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CursorMovements<Cursor> for EditRope

fn range_of_movement( &self, cursor: &Cursor, movement: &MoveType, count: &Count, ctx: &CursorMovementsContext<'_, Cursor> ) -> Option<EditRange<Cursor>>

Given an action’s movement, calculate the affected range base on the cursor’s current position.

fn first_word( &self, cursor: &Cursor, _: &CursorMovementsContext<'_, Cursor> ) -> Cursor

Calculate the position of the first word on the line of the provided cursor.

fn movement( &self, cursor: &Cursor, movement: &MoveType, count: &Count, ctx: &CursorMovementsContext<'_, Cursor> ) -> Option<Cursor>

Calculate the position of the cursor after performing a movement.

fn range( &self, cursor: &Cursor, range: &RangeType, inclusive: bool, count: &Count, ctx: &CursorMovementsContext<'_, Cursor> ) -> Option<EditRange<Cursor>>

Calculate a cursor range based on a given cursor position and a RangeType.

impl CursorSearch<Cursor> for EditRope

fn find_char( &self, cursor: &Cursor, inclusive: bool, dir: MoveDir1D, multiline: bool, needle: char, count: usize ) -> Option<Cursor>

Search for a specific character.

fn find_matches( &self, start: &Cursor, end: &Cursor, needle: &Regex ) -> Vec<EditRange<Cursor>>

Find matches for a regular expression within a range.

fn find_regex( &self, cursor: &Cursor, dir: MoveDir1D, needle: &Regex, count: usize ) -> Option<EditRange<Cursor>>

Search for a regular expression.

impl Debug for EditRope

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

Formats the value using the given formatter.

impl<'a> From<&'a EditRope> for Cow<'a, str>

fn from(s: &'a EditRope) -> Self

Converts to this type from the input type.

impl From<&str> for EditRope

fn from(s: &str) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for EditRope

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<EditRope> for RegisterCell

fn from(s: EditRope) -> RegisterCell

Converts to this type from the input type.

impl From<String> for EditRope

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<char> for EditRope

fn from(c: char) -> Self

Converts to this type from the input type.

impl PartialEq<&str> for EditRope

fn eq(&self, other: &&str) -> 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 PartialEq for EditRope

fn eq(&self, other: &Self) -> 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 ToString for EditRope

fn to_string(&self) -> String

Converts the given value to a String.

impl Eq for EditRope