Struct Document 

pub struct Document { /* private fields */ }

Implementations

impl Document

pub fn new(text: &str) -> Self

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

The text in order, in the rope’s pieces (for hashing without a copy).

pub fn len(&self) -> ByteOffset

Length in bytes; also the offset of the end of the document.

pub fn is_empty(&self) -> bool

pub fn line_count(&self) -> usize

Number of lines. An empty document, or one ending in \n, still has a (possibly empty) last line.

pub fn line_of(&self, pos: ByteOffset) -> usize

Line containing pos. A \n belongs to the line it ends.

pub fn line_start(&self, line: usize) -> ByteOffset

pub fn line_end(&self, line: usize) -> ByteOffset

End of the line’s content, excluding its \n.

pub fn line_text(&self, line: usize) -> String

The line’s content, excluding its \n.

pub fn slice(&self, range: Range<ByteOffset>) -> String

pub fn is_char_boundary(&self, pos: ByteOffset) -> bool

pub fn chunk_at(&self, pos: ByteOffset) -> (&str, ByteOffset)

The chunk of text containing pos and the offset at which it starts. At the end of the document this is the last chunk. Grapheme segmentation in position walks the rope with this.

pub fn char_at(&self, pos: ByteOffset) -> Option<char>

The char starting at pos, if any.

pub fn to_char_idx(&self, pos: ByteOffset) -> CharIdx

pub fn replace(&mut self, range: Range<ByteOffset>, text: &str)

Replaces range with text. Both ends must be char boundaries.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl Display for Document

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

Formats the value using the given formatter.