Struct duat_core::text::Text

pub struct Text {
    pub tags: Box<Tags>,
    pub records: Records<(usize, usize, usize)>,
    /* private fields */
}

The text in a given area.

Fields

tags: Box<Tags>

records: Records<(usize, usize, usize)>

Implementations

impl Text

pub fn new() -> Self

pub fn from_file(path: impl AsRef<Path>) -> Self

pub fn builder() -> Builder

pub fn insert_tag(&mut self, at: usize, tag: Tag, marker: Marker)

pub fn remove_tags_on(&mut self, b: usize, markers: impl Markers)

pub fn slices(&self) -> (&str, &str)

pub fn slices_range(&self, range: impl RangeBounds<usize>) -> (&str, &str)

pub fn tags(&self) -> impl Iterator<Item = (usize, RawTag)> + '_

pub fn tags_at( &self, at: usize, ) -> impl Iterator<Item = (usize, RawTag)> + Clone + '_

pub fn chars(&self) -> impl Iterator<Item = char> + Clone + '_

pub fn is_empty(&self) -> bool

pub fn get_point_at(&self, at: usize) -> Option<Point>

pub fn ghost_max_points_at(&self, at: usize) -> Option<(Point, Option<Point>)>

pub fn points_after(&self, tp: impl TwoPoints) -> Option<(Point, Option<Point>)>

Points visually after the [TwoPoints]

If the [TwoPoints] in question is concealed, treats the next visible character as the first character, and returns the points of the next visible character.

This method is useful if you want to iterater reversibly right after a certain point, thus including the character of said point.

pub fn len_bytes(&self) -> usize

pub fn len_chars(&self) -> usize

pub fn len_lines(&self) -> usize

pub fn max_point(&self) -> Point

pub fn visual_line_start(&self, p: impl TwoPoints) -> (Point, Option<Point>)

The visual start of the line

This point is defined not by where the line actually begins, but by where the last ‘\n’ was located. For example, if Tags create ghost text or ommit text from multiple different lines, this point may differ from where in the Text the physical line actually begins.

impl Text

pub fn iter(&self) -> Iter<'_>

pub fn iter_at(&self, p: impl TwoPoints) -> Iter<'_>

pub fn rev_iter(&self) -> RevIter<'_>

pub fn rev_iter_at(&self, p: impl TwoPoints) -> RevIter<'_>

pub fn iter_bytes_at(&self, b: usize) -> impl Iterator<Item = u8> + '_

pub fn iter_chars_at(&self, c: usize) -> impl Iterator<Item = char> + '_

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Text

Returns the “default value” for a type.

impl<S> From<S> for Text

where S: ToString,

fn from(value: S) -> Self

Converts to this type from the input type.

impl From<Text> for BuilderPart<String>

fn from(value: Text) -> Self

Converts to this type from the input type.

impl PartialEq for Text

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Text