Struct Rope 

pub struct Rope<'a> { /* private fields */ }

A rope data structure.

Implementations

impl<'a> Rope<'a>

pub const fn new() -> Self

Creates a new empty rope.

pub fn add(&mut self, value: &'a str)

Adds a string slice to the end of the rope.

Converts from simple to complex representation on first add. Empty strings are ignored.

pub fn append(&mut self, value: Rope<'a>)

Appends another rope to this rope.

Handles all combinations of simple and complex representations efficiently.

pub fn byte(&self, byte_index: usize) -> u8

Gets the byte at the given index.

Panics

When index is out of bounds.

pub fn get_byte(&self, byte_index: usize) -> Option<u8>

Non-panicking version of Rope::byte.

Gets the byte at the given index, returning None if out of bounds.

pub fn char_indices(&self) -> CharIndices<'_>

Returns an iterator over the characters and their byte positions.

pub fn starts_with(&self, value: &Rope<'_>) -> bool

Returns whether the rope starts with the given string.

pub fn ends_with(&self, value: char) -> bool

Returns whether the rope ends with the given string.

pub fn is_empty(&self) -> bool

Returns whether the rope is empty.

pub fn len(&self) -> usize

Returns the length of the rope in bytes.

pub fn byte_slice<R>(&self, range: R) -> Rope<'a>

where R: RangeBounds<usize>,

Returns a slice of the rope in the given byte range.

Panics

• When start > end
• When end is out of bounds
• When indices are not on char boundaries

pub fn get_byte_slice<R>(&self, range: R) -> Option<Rope<'a>>

where R: RangeBounds<usize>,

Non-panicking version of Rope::byte_slice.

pub unsafe fn byte_slice_unchecked<R>(&self, range: R) -> Rope<'a>

where R: RangeBounds<usize>,

Range-unchecked version of Rope::byte_slice.

Safety

This is not safe, due to the following invariants that must be upheld:

• Range must be within bounds.
• Range start must be less than or equal to the end.
• Both range start and end must be on char boundaries.

pub fn lines(&self) -> Lines<'_, 'a>

Returns an iterator over the lines of the rope.

pub fn to_bytes(&self) -> Cow<'a, [u8]>

Converts the rope to bytes.

Returns borrowed bytes for simple ropes and owned bytes for complex ropes.

Trait Implementations

impl<'a> Clone for Rope<'a>

fn clone(&self) -> Rope<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Rope<'a>

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

Formats the value using the given formatter.

impl Default for Rope<'_>

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl<'a> From<&'a String> for Rope<'a>

fn from(value: &'a String) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for Rope<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a str> for Rope<'a>

fn from_iter<T: IntoIterator<Item = &'a str>>(iter: T) -> Self

Creates a value from an iterator.

impl Hash for Rope<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<&str> for Rope<'_>

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<Rope<'_>> for Rope<'_>

fn eq(&self, other: &Rope<'_>) -> 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 Rope<'_>

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 ToString for Rope<'_>

fn to_string(&self) -> String

Converts the given value to a String.