Struct ropey::RopeSlice [−][src]
pub struct RopeSlice<'a>(_);
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
content truncate that content to the range of the slice.
In other words, the behavior of a RopeSlice
is always identical to that
of a full Rope
with the same content.
Methods
impl<'a> RopeSlice<'a>
[src]
impl<'a> RopeSlice<'a>
pub fn len_bytes(&self) -> usize
[src]
pub fn len_bytes(&self) -> usize
Total number of bytes in the RopeSlice
.
Runs in O(1) time.
pub fn len_chars(&self) -> usize
[src]
pub fn len_chars(&self) -> usize
Total number of chars in the RopeSlice
.
Runs in O(1) time.
pub fn len_lines(&self) -> usize
[src]
pub fn len_lines(&self) -> usize
Total number of lines in the RopeSlice
.
Runs in O(1) time.
pub fn byte_to_char(&self, byte_idx: usize) -> usize
[src]
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()
).
pub fn byte_to_line(&self, byte_idx: usize) -> usize
[src]
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()
).
pub fn char_to_byte(&self, char_idx: usize) -> usize
[src]
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()
).
pub fn char_to_line(&self, char_idx: usize) -> usize
[src]
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()
).
pub fn line_to_byte(&self, line_idx: usize) -> usize
[src]
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()
).
pub fn line_to_char(&self, line_idx: usize) -> usize
[src]
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()
).
pub fn char(&self, char_idx: usize) -> char
[src]
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()
).
pub fn line(&self, line_idx: usize) -> RopeSlice<'a>
[src]
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()
).
pub fn chunk_at_byte(&self, byte_idx: usize) -> (&'a str, usize, usize, usize)
[src]
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()
).
pub fn chunk_at_char(&self, char_idx: usize) -> (&'a str, usize, usize, usize)
[src]
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()
).
pub fn chunk_at_line_break(
&self,
line_break_idx: usize
) -> (&'a str, usize, usize, usize)
[src]
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()
).
pub fn as_str(&self) -> Option<&'a str>
[src]
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.
Runs in O(1) time.
pub fn from_str(text: &str) -> RopeSlice
[src]
pub fn from_str(text: &str) -> RopeSlice
Creates a RopeSlice
directly from a string slice.
Despite its straightforward name, the useful applications of this
method are 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.
pub fn slice<R: CharIdxRange>(&self, char_range: R) -> Self
[src]
pub fn slice<R: CharIdxRange>(&self, char_range: R) -> Self
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()
).
ⓘImportant traits for Bytes<'a>pub fn bytes(&self) -> Bytes<'a>
[src]
pub fn bytes(&self) -> Bytes<'a>
Creates an iterator over the bytes of the RopeSlice
.
ⓘImportant traits for Chars<'a>pub fn chars(&self) -> Chars<'a>
[src]
pub fn chars(&self) -> Chars<'a>
Creates an iterator over the chars of the RopeSlice
.
ⓘImportant traits for Lines<'a>pub fn lines(&self) -> Lines<'a>
[src]
pub fn lines(&self) -> Lines<'a>
Creates an iterator over the lines of the RopeSlice
.
ⓘImportant traits for Chunks<'a>pub fn chunks(&self) -> Chunks<'a>
[src]
pub fn chunks(&self) -> Chunks<'a>
Creates an iterator over the chunks of the RopeSlice
.
pub fn to_string(&self) -> String
[src]
pub fn to_string(&self) -> String
Returns the entire text of the RopeSlice
as a newly allocated String
.
Runs in O(N) time.
pub fn to_rope(&self) -> Rope
[src]
pub fn to_rope(&self) -> Rope
Creates a new Rope
from the contents of the RopeSlice
.
Shares data where possible.
Perhaps unexpectedly, runs in O(log N) time, not O(1) time like
Rope
cloning.
Trait Implementations
impl<'a> Copy for RopeSlice<'a>
[src]
impl<'a> Copy for RopeSlice<'a>
impl<'a> Clone for RopeSlice<'a>
[src]
impl<'a> Clone for RopeSlice<'a>
fn clone(&self) -> RopeSlice<'a>
[src]
fn clone(&self) -> RopeSlice<'a>
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl<'a> Debug for RopeSlice<'a>
[src]
impl<'a> Debug for RopeSlice<'a>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<'a> Display for RopeSlice<'a>
[src]
impl<'a> Display for RopeSlice<'a>
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl<'a, 'b> PartialEq<RopeSlice<'b>> for RopeSlice<'a>
[src]
impl<'a, 'b> PartialEq<RopeSlice<'b>> for RopeSlice<'a>
fn eq(&self, other: &RopeSlice<'b>) -> bool
[src]
fn eq(&self, other: &RopeSlice<'b>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<&'b str> for RopeSlice<'a>
[src]
impl<'a, 'b> PartialEq<&'b str> for RopeSlice<'a>
fn eq(&self, other: &&'b str) -> bool
[src]
fn eq(&self, other: &&'b str) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<RopeSlice<'a>> for &'b str
[src]
impl<'a, 'b> PartialEq<RopeSlice<'a>> for &'b str
fn eq(&self, other: &RopeSlice<'a>) -> bool
[src]
fn eq(&self, other: &RopeSlice<'a>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> PartialEq<str> for RopeSlice<'a>
[src]
impl<'a> PartialEq<str> for RopeSlice<'a>
fn eq(&self, other: &str) -> bool
[src]
fn eq(&self, other: &str) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> PartialEq<RopeSlice<'a>> for str
[src]
impl<'a> PartialEq<RopeSlice<'a>> for str
fn eq(&self, other: &RopeSlice<'a>) -> bool
[src]
fn eq(&self, other: &RopeSlice<'a>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> PartialEq<String> for RopeSlice<'a>
[src]
impl<'a> PartialEq<String> for RopeSlice<'a>
fn eq(&self, other: &String) -> bool
[src]
fn eq(&self, other: &String) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> PartialEq<RopeSlice<'a>> for String
[src]
impl<'a> PartialEq<RopeSlice<'a>> for String
fn eq(&self, other: &RopeSlice<'a>) -> bool
[src]
fn eq(&self, other: &RopeSlice<'a>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<Cow<'b, str>> for RopeSlice<'a>
[src]
impl<'a, 'b> PartialEq<Cow<'b, str>> for RopeSlice<'a>
fn eq(&self, other: &Cow<'b, str>) -> bool
[src]
fn eq(&self, other: &Cow<'b, str>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a, 'b> PartialEq<RopeSlice<'a>> for Cow<'b, str>
[src]
impl<'a, 'b> PartialEq<RopeSlice<'a>> for Cow<'b, str>
fn eq(&self, other: &RopeSlice<'a>) -> bool
[src]
fn eq(&self, other: &RopeSlice<'a>) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> PartialEq<Rope> for RopeSlice<'a>
[src]
impl<'a> PartialEq<Rope> for RopeSlice<'a>
fn eq(&self, other: &Rope) -> bool
[src]
fn eq(&self, other: &Rope) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
fn ne(&self, other: &Rhs) -> bool
This method tests for !=
.
impl<'a> PartialEq<RopeSlice<'a>> for Rope
[src]
impl<'a> PartialEq<RopeSlice<'a>> for Rope