Struct JumpRopeBuf

pub struct JumpRopeBuf(/* private fields */);

This struct provides an optimized wrapper around JumpRope which buffers adjacent incoming writes before forwarding them to the underlying JumpRope.

Most of the overhead of writing to a rope comes from finding the edit location in the rope and bookkeeping. Because text editing operations are usually sequential, by aggregating adjacent editing operations together we can amortize the cost of updating the underlying data structure itself. This improves performance by about 10x compared to inserting and deleting individual characters.

There is nothing jumprope-specific in this library. It could easily be adapted to wrap other rope libraries (like Ropey) too.

This API is still experimental. This library is only enabled by enabling the “buffered’ feature.

Implementations

impl JumpRopeBuf

pub fn with_rope(rope: JumpRope) -> Self

pub fn new() -> Self

pub fn new_from_str(s: &str) -> Self

pub fn insert(&mut self, pos: usize, content: &str)

Insert new content into the rope at the specified position. This method is semantically equivalent to JumpRope::insert. The only difference is that here we buffer the incoming edit.

pub fn remove(&mut self, range: Range<usize>)

Remove content from the rope at the specified position. This method is semantically equivalent to JumpRope::remove. The only difference is that here we buffer the incoming remove operation.

pub fn len_chars(&self) -> usize

Return the length of the rope in unicode characters. Note this is not the same as either the number of bytes the characters take, or the number of grapheme clusters in the string.

This method returns the length in constant-time (O(1)).

pub fn len_bytes(&self) -> usize

Get the number of bytes used for the UTF8 representation of the rope. This will always match the .len() property of the equivalent String.

pub fn is_empty(&self) -> bool

pub fn into_inner(self) -> JumpRope

Consume the JumpRopeBuf, flush any buffered operations and return the contained JumpRope.

pub fn borrow(&self) -> Ref<'_, JumpRope>

Flush changes into the rope and return a borrowed reference to the rope itself. This makes it easy to call any methods on the underlying rope which aren’t already exposed through the buffered API.

Panics

borrow panics if the value is currently borrowed already.

Trait Implementations

impl AsMut<JumpRope> for JumpRopeBuf

fn as_mut(&mut self) -> &mut JumpRope

Flush changes into the rope and mutably borrow the rope.

impl Clone for JumpRopeBuf

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JumpRopeBuf

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

Formats the value using the given formatter.

impl Default for JumpRopeBuf

fn default() -> Self

Returns the “default value” for a type.

impl Display for JumpRopeBuf

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

Formats the value using the given formatter.

impl From<JumpRope> for JumpRopeBuf

fn from(rope: JumpRope) -> Self

Converts to this type from the input type.

impl<S: AsRef<str>> From<S> for JumpRopeBuf

fn from(str: S) -> Self

Converts to this type from the input type.

impl PartialEq<JumpRope> for JumpRopeBuf

fn eq(&self, other: &JumpRope) -> 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 PartialEq<String> for &JumpRopeBuf

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

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

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

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