Skip to main content

Rope

Struct Rope 

Source
pub struct Rope { /* private fields */ }
Expand description

Rope-backed text storage.

Implementations§

Source§

impl Rope

Source

pub fn new() -> Self

Create an empty rope.

Source

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

Create a rope from a string slice.

This is a convenience method. You can also use .parse() or From<&str>.

Source

pub fn len_bytes(&self) -> usize

Total length in bytes.

Source

pub fn len_chars(&self) -> usize

Total length in Unicode scalar values.

Source

pub fn len_lines(&self) -> usize

Total number of lines (newline count + 1).

Source

pub fn is_empty(&self) -> bool

Returns true if the rope is empty.

Source

pub fn line(&self, idx: usize) -> Option<Cow<'_, str>>

Get a line by index.

Source

pub fn lines(&self) -> impl Iterator<Item = Cow<'_, str>> + '_

Iterate over all lines.

Source

pub fn slice<R>(&self, range: R) -> Cow<'_, str>
where R: RangeBounds<usize>,

Get a slice of the rope by character range.

Source

pub fn insert(&mut self, char_idx: usize, text: &str)

Insert text at a character index.

Source

pub fn insert_grapheme(&mut self, grapheme_idx: usize, text: &str)

Insert text at a grapheme index.

Source

pub fn remove<R>(&mut self, range: R)
where R: RangeBounds<usize>,

Remove a character range.

Source

pub fn remove_grapheme_range<R>(&mut self, range: R)
where R: RangeBounds<usize>,

Remove a grapheme range.

Source

pub fn replace(&mut self, text: &str)

Replace the entire contents.

Source

pub fn append(&mut self, text: &str)

Append text to the end.

Source

pub fn clear(&mut self)

Clear all content.

Source

pub fn char_to_byte(&self, char_idx: usize) -> usize

Convert a character index to a byte index.

Source

pub fn byte_to_char(&self, byte_idx: usize) -> usize

Convert a byte index to a character index.

Source

pub fn char_to_line(&self, char_idx: usize) -> usize

Convert a character index to a line index.

Source

pub fn line_to_char(&self, line_idx: usize) -> usize

Get the character index at the start of a line.

Source

pub fn byte_to_line_col(&self, byte_idx: usize) -> (usize, usize)

Convert a byte index to (line, column) in characters.

Source

pub fn line_col_to_byte(&self, line_idx: usize, col: usize) -> usize

Convert (line, column) in characters to a byte index.

Source

pub fn chars(&self) -> impl Iterator<Item = char> + '_

Iterate over all characters.

Source

pub fn graphemes(&self) -> Vec<String>

Return all graphemes as owned strings.

Source

pub fn grapheme_count(&self) -> usize

Count grapheme clusters.

Trait Implementations§

Source§

impl Clone for Rope

Source§

fn clone(&self) -> Rope

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Rope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Rope

Source§

fn default() -> Rope

Returns the “default value” for a type. Read more
Source§

impl Display for Rope

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&str> for Rope

Source§

fn from(s: &str) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Rope

Source§

fn from(s: String) -> Self

Converts to this type from the input type.
Source§

impl FromStr for Rope

Source§

type Err = Infallible

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

Auto Trait Implementations§

§

impl Freeze for Rope

§

impl RefUnwindSafe for Rope

§

impl Send for Rope

§

impl Sync for Rope

§

impl Unpin for Rope

§

impl UnsafeUnpin for Rope

§

impl UnwindSafe for Rope

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more