pub struct RopeSlice<'a>(_);
Expand description
An immutable view into part of a Rope
.
Just like standard &str
slices, RopeSlice
s behave as if the text in
their range is the only text that exists. All indexing is relative to
the start of their range, and all iterators and methods that return text
truncate that text to the range of the slice.
In other words, the behavior of a RopeSlice
is always identical to that
of a full Rope
created from the same text range. Nothing should be
surprising here.
Implementations§
source§impl<'a> RopeSlice<'a>
impl<'a> RopeSlice<'a>
sourcepub fn byte_to_char(&self, byte_idx: usize) -> usize
pub fn byte_to_char(&self, byte_idx: usize) -> usize
Returns the char index of the given byte.
Notes:
- If the byte is in the middle of a multi-byte char, returns the index of the char that the byte belongs to.
byte_idx
can be one-past-the-end, which will return one-past-the-end char index.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
sourcepub fn byte_to_line(&self, byte_idx: usize) -> usize
pub fn byte_to_line(&self, byte_idx: usize) -> usize
Returns the line index of the given byte.
Notes:
- Lines are zero-indexed. This is functionally equivalent to counting the line endings before the specified byte.
byte_idx
can be one-past-the-end, which will return the last line index.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
sourcepub fn char_to_byte(&self, char_idx: usize) -> usize
pub fn char_to_byte(&self, char_idx: usize) -> usize
Returns the byte index of the given char.
Notes:
char_idx
can be one-past-the-end, which will return one-past-the-end byte index.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
sourcepub fn char_to_line(&self, char_idx: usize) -> usize
pub fn char_to_line(&self, char_idx: usize) -> usize
Returns the line index of the given char.
Notes:
- Lines are zero-indexed. This is functionally equivalent to counting the line endings before the specified char.
char_idx
can be one-past-the-end, which will return the last line index.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
sourcepub fn line_to_byte(&self, line_idx: usize) -> usize
pub fn line_to_byte(&self, line_idx: usize) -> usize
Returns the byte index of the start of the given line.
Notes:
- Lines are zero-indexed.
line_idx
can be one-past-the-end, which will return one-past-the-end byte index.
Panics
Panics if line_idx
is out of bounds (i.e. line_idx > len_lines()
).
sourcepub fn line_to_char(&self, line_idx: usize) -> usize
pub fn line_to_char(&self, line_idx: usize) -> usize
Returns the char index of the start of the given line.
Notes:
- Lines are zero-indexed.
line_idx
can be one-past-the-end, which will return one-past-the-end char index.
Panics
Panics if line_idx
is out of bounds (i.e. line_idx > len_lines()
).
sourcepub fn byte(&self, byte_idx: usize) -> u8
pub fn byte(&self, byte_idx: usize) -> u8
Returns the byte at byte_idx
.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx >= len_bytes()
).
sourcepub fn char(&self, char_idx: usize) -> char
pub fn char(&self, char_idx: usize) -> char
Returns the char at char_idx
.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx >= len_chars()
).
sourcepub fn line(&self, line_idx: usize) -> RopeSlice<'a>
pub fn line(&self, line_idx: usize) -> RopeSlice<'a>
Returns the line at line_idx
.
Note: lines are zero-indexed.
Panics
Panics if line_idx
is out of bounds (i.e. line_idx >= len_lines()
).
sourcepub fn chunk_at_byte(&self, byte_idx: usize) -> (&'a str, usize, usize, usize)
pub fn chunk_at_byte(&self, byte_idx: usize) -> (&'a str, usize, usize, usize)
Returns the chunk containing the given byte index.
Also returns the byte and char indices of the beginning of the chunk and the index of the line that the chunk starts on.
The return value is organized as (chunk, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
sourcepub fn chunk_at_char(&self, char_idx: usize) -> (&'a str, usize, usize, usize)
pub fn chunk_at_char(&self, char_idx: usize) -> (&'a str, usize, usize, usize)
Returns the chunk containing the given char index.
Also returns the byte and char indices of the beginning of the chunk and the index of the line that the chunk starts on.
The return value is organized as (chunk, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
sourcepub fn chunk_at_line_break(
&self,
line_break_idx: usize
) -> (&'a str, usize, usize, usize)
pub fn chunk_at_line_break(
&self,
line_break_idx: usize
) -> (&'a str, usize, usize, usize)
Returns the chunk containing the given line break.
Also returns the byte and char indices of the beginning of the chunk and the index of the line that the chunk starts on.
Note: for convenience, both the beginning and end of the slice are
considered line breaks for the purposes of indexing. For example, in
the string "Hello \n world!"
0 would give the first chunk, 1 would
give the chunk containing the newline character, and 2 would give the
last chunk.
The return value is organized as (chunk, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Panics
Panics if line_break_idx
is out of bounds (i.e. line_break_idx > len_lines()
).
sourcepub fn as_str(&self) -> Option<&'a str>
pub fn as_str(&self) -> Option<&'a str>
Returns the entire contents of the RopeSlice
as a &str
if
possible.
This is useful for optimizing cases where the slice is only a few characters or words, and therefore has a high chance of being contiguous in memory.
For large slices this method will typically fail and return None
because large slices usually cross chunk boundaries in the rope.
(Also see the From
impl for converting to a Cow<str>
.)
Runs in O(1) time.
sourcepub fn slice<R>(&self, char_range: R) -> Selfwhere
R: RangeBounds<usize>,
pub fn slice<R>(&self, char_range: R) -> Selfwhere
R: RangeBounds<usize>,
Returns a sub-slice of the RopeSlice
in the given char index range.
Uses range syntax, e.g. 2..7
, 2..
, etc.
Panics
Panics if the start of the range is greater than the end, or the end
is out of bounds (i.e. end > len_chars()
).
Trait Implementations§
source§impl<'a> From<&'a str> for RopeSlice<'a>
impl<'a> From<&'a str> for RopeSlice<'a>
Creates a RopeSlice
directly from a string slice.
The useful applications of this are actually somewhat narrow. It is
intended primarily as an aid when implementing additional functionality
on top of Ropey, where you may already have access to a rope chunk and
want to directly create a RopeSlice
from it, avoiding the overhead of
going through the slicing APIs.
Although it is possible to use this to create RopeSlice
s from
arbitrary strings, doing so is not especially useful. For example,
Rope
s and RopeSlice
s can already be directly compared for
equality with strings and string slices.
Runs in O(N) time, where N is the length of the string slice.
source§impl<'a> From<RopeSlice<'a>> for Cow<'a, str>
impl<'a> From<RopeSlice<'a>> for Cow<'a, str>
Attempts to borrow the contents of the slice, but will convert to an owned string if the contents is not contiguous in memory.
Runs in best case O(1), worst case O(N).
source§impl<'a> Ord for RopeSlice<'a>
impl<'a> Ord for RopeSlice<'a>
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl<'a, 'b> PartialEq<&'b str> for RopeSlice<'a>
impl<'a, 'b> PartialEq<&'b str> for RopeSlice<'a>
source§impl<'a, 'b> PartialEq<Cow<'b, str>> for RopeSlice<'a>
impl<'a, 'b> PartialEq<Cow<'b, str>> for RopeSlice<'a>
source§impl<'a, 'b> PartialEq<RopeSlice<'a>> for &'b str
impl<'a, 'b> PartialEq<RopeSlice<'a>> for &'b str
source§impl<'a, 'b> PartialEq<RopeSlice<'a>> for Cow<'b, str>
impl<'a, 'b> PartialEq<RopeSlice<'a>> for Cow<'b, str>
source§impl<'a> PartialEq<RopeSlice<'a>> for String
impl<'a> PartialEq<RopeSlice<'a>> for String
source§impl<'a, 'b> PartialEq<RopeSlice<'b>> for RopeSlice<'a>
impl<'a, 'b> PartialEq<RopeSlice<'b>> for RopeSlice<'a>
source§impl<'a, 'b> PartialOrd<RopeSlice<'b>> for RopeSlice<'a>
impl<'a, 'b> PartialOrd<RopeSlice<'b>> for RopeSlice<'a>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read more