Struct ropey::RopeSlice [−][src]
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
Total number of utf16 code units that would be in the RopeSlice
if
it were encoded as utf16.
Ropey stores text internally as utf8, but sometimes it is necessary to interact with external APIs that still use utf16. This function is primarily intended for such situations, and is otherwise not very useful.
Runs in O(1) time.
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.
Runs in O(log N) time.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
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.
Runs in O(log N) time.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
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.
Runs in O(log N) time.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
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.
Runs in O(log N) time.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
Returns the utf16 code unit index of the given char.
Ropey stores text internally as utf8, but sometimes it is necessary to interact with external APIs that still use utf16. This function is primarily intended for such situations, and is otherwise not very useful.
Runs in O(log N) time.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
Returns the char index of the given utf16 code unit.
Ropey stores text internally as utf8, but sometimes it is necessary to interact with external APIs that still use utf16. This function is primarily intended for such situations, and is otherwise not very useful.
Note: if the utf16 code unit is in the middle of a char, returns the index of the char that it belongs to.
Runs in O(log N) time.
Panics
Panics if utf16_cu_idx
is out of bounds
(i.e. utf16_cu_idx > len_utf16_cu()
).
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.
Runs in O(log N) time.
Panics
Panics if line_idx
is out of bounds (i.e. line_idx > len_lines()
).
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.
Runs in O(log N) time.
Panics
Panics if line_idx
is out of bounds (i.e. line_idx > len_lines()
).
Returns the byte at byte_idx
.
Runs in O(log N) time.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx >= len_bytes()
).
Returns the char at char_idx
.
Runs in O(log N) time.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx >= len_chars()
).
Returns the line at line_idx
.
Note: lines are zero-indexed.
Runs in O(log N) time.
Panics
Panics if line_idx
is out of bounds (i.e. line_idx >= len_lines()
).
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.
Note: for convenience, a one-past-the-end byte_idx
returns the last
chunk of the RopeSlice
.
The return value is organized as
(chunk, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Runs in O(log N) time.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
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.
Note: for convenience, a one-past-the-end char_idx
returns the last
chunk of the RopeSlice
.
The return value is organized as
(chunk, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Runs in O(log N) time.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
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)
.
Runs in O(log N) time.
Panics
Panics if line_break_idx
is out of bounds (i.e. line_break_idx > len_lines()
).
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.
Returns a sub-slice of the RopeSlice
in the given char index range.
Uses range syntax, e.g. 2..7
, 2..
, etc.
Runs in O(log N) time.
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()
).
Creates an iterator over the bytes of the RopeSlice
.
Runs in O(log N) time.
Creates an iterator over the bytes of the RopeSlice
, starting at
byte byte_idx
.
If byte_idx == len_bytes()
then an iterator at the end of the
RopeSlice
is created (i.e. next()
will return None
).
Runs in O(log N) time.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
Creates an iterator over the chars of the RopeSlice
.
Runs in O(log N) time.
Creates an iterator over the chars of the RopeSlice
, starting at
char char_idx
.
If char_idx == len_chars()
then an iterator at the end of the
RopeSlice
is created (i.e. next()
will return None
).
Runs in O(log N) time.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
Creates an iterator over the lines of the RopeSlice
.
Runs in O(log N) time.
Creates an iterator over the lines of the RopeSlice
, starting at
line line_idx
.
If line_idx == len_lines()
then an iterator at the end of the
RopeSlice
is created (i.e. next()
will return None
).
Runs in O(log N) time.
Panics
Panics if line_idx
is out of bounds (i.e. line_idx > len_lines()
).
Creates an iterator over the chunks of the RopeSlice
.
Runs in O(log N) time.
Creates an iterator over the chunks of the RopeSlice
, with the
iterator starting at the byte containing byte_idx
.
Also returns the byte and char indices of the beginning of the first chunk to be yielded, and the index of the line that chunk starts on.
If byte_idx == len_bytes()
an iterator at the end of the RopeSlice
(yielding None
on a call to next()
) is created.
The return value is organized as
(iterator, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Runs in O(log N) time.
Panics
Panics if byte_idx
is out of bounds (i.e. byte_idx > len_bytes()
).
Creates an iterator over the chunks of the RopeSlice
, with the
iterator starting on the chunk containing char_idx
.
Also returns the byte and char indices of the beginning of the first chunk to be yielded, and the index of the line that chunk starts on.
If char_idx == len_chars()
an iterator at the end of the RopeSlice
(yielding None
on a call to next()
) is created.
The return value is organized as
(iterator, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Runs in O(log N) time.
Panics
Panics if char_idx
is out of bounds (i.e. char_idx > len_chars()
).
Creates an iterator over the chunks of the RopeSlice
, with the
iterator starting at the chunk containing line_break_idx
.
Also returns the byte and char indices of the beginning of the first chunk to be yielded, and the index of the line that chunk starts on.
Note: for convenience, both the beginning and end of the RopeSlice
are
considered line breaks for the purposes of indexing. For example, in
the string "Hello \n world!"
0 would create an iterator starting on
the first chunk, 1 would create an iterator starting on the chunk
containing the newline character, and 2 would create an iterator at
the end of the RopeSlice
(yielding None
on a call to next()
).
The return value is organized as
(iterator, chunk_byte_idx, chunk_char_idx, chunk_line_idx)
.
Runs in O(log N) time.
Panics
Panics if line_break_idx
is out of bounds (i.e. line_break_idx > len_lines()
).
Non-Panicking
The methods in this impl block provide non-panicking versions of
RopeSlice
’s panicking methods. They return either Option::None
or
Result::Err()
when their panicking counterparts would have panicked.
Non-panicking version of byte_to_char()
.
Non-panicking version of byte_to_line()
.
Non-panicking version of char_to_byte()
.
Non-panicking version of char_to_line()
.
Non-panicking version of char_to_utf16_cu()
.
Non-panicking version of utf16_cu_to_char()
.
Non-panicking version of line_to_byte()
.
Non-panicking version of line_to_char()
.
Non-panicking version of line()
.
Non-panicking version of chunk_at_byte()
.
Non-panicking version of chunk_at_char()
.
Non-panicking version of chunk_at_line_break()
.
Non-panicking version of slice()
.
Non-panicking version of bytes_at()
.
Non-panicking version of chars_at()
.
Non-panicking version of lines_at()
.
Non-panicking version of chunks_at_byte()
.
Non-panicking version of chunks_at_char()
.
Trait Implementations
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.
Will share data where possible.
Runs in O(log N) time.
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).
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for RopeSlice<'a>
impl<'a> UnwindSafe for RopeSlice<'a>
Blanket Implementations
Mutably borrows from an owned value. Read more