termint 0.8.1

Library for colored printing and Terminal User Interfaces
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

use core::fmt;

use crate::{
    buffer::Buffer,
    enums::Wrap,
    geometry::{Rect, Vec2},
};

/// A trait implemented by all the widgets that render styled or formatted
/// text.
pub trait Text {
    /// Renders the [`Text`] into the given buffer within the provided [`Rect`]
    /// bounds, starting at the given offset and applying the specified
    /// wrapping strategy.
    ///
    /// Returns the final position where the rendering ends.
    ///
    /// # Example
    /// ```rust
    /// # use termint::{
    /// #     geometry::Rect, text::Text, widgets::ToSpan,
    /// #     enums::Wrap, buffer::Buffer
    /// # };
    /// let span = "Hello, Termint!".to_span();
    ///
    /// let rect = Rect::new(1, 1, 20, 1);
    /// let mut buffer = Buffer::empty(rect);
    ///
    /// // Renders text with offset of 3 with word wrapping
    /// span.render_offset(&mut buffer, rect, 3, Some(Wrap::Word));
    /// ```
    fn render_offset(
        &self,
        buffer: &mut Buffer,
        rect: Rect,
        offset: usize,
        wrap: Option<Wrap>,
    ) -> Vec2;

    /// Returns the formatted representation of the text as a `String`.
    fn get(&self) -> String;

    /// Returns the raw, unformatted string content.
    fn get_text(&self) -> &str;

    /// Returns ANSI escape sequences representing the current style
    /// (e.g., foreground/background colors, modifiers).
    fn get_mods(&self) -> String;
}

impl fmt::Debug for dyn Text {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Converted text")
    }
}