termal_core 5.0.0

This library contains implementation for the termal library
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

use super::TermTextSpans;

/// Information about text with control sequences.
#[derive(Debug, Copy, Clone, Default)]
pub struct TermTextMetadata {
    /// Total number of chars.
    pub chars: usize,
    /// Number of columns used when the characters are displayed.
    pub columns: usize,
    /// Number of chars from control sequences.
    pub control_chars: usize,
    /// Number of bytes from control sequences.
    pub control_bytes: usize,
}

impl TermTextMetadata {
    /// Get the metadata from the given text.
    pub fn from_text(text: &str) -> Self {
        let mut res = TermTextMetadata::default();
        res.add_length(text);
        res
    }

    /// Add to the metadata with metadata of the given text.
    pub fn add_length(&mut self, text: &str) {
        for span in TermTextSpans::new(text) {
            self.chars += span.chars();
            self.columns += span.columns();
            if span.is_control() {
                self.control_chars += span.chars();
                self.control_bytes += span.text().len();
            }
        }
    }

    /// Get the number of display characters.
    pub fn display_chars(&self) -> usize {
        self.chars - self.control_chars
    }
}