interm 0.1.1

InTerm is a library for creating interactive terminal applications.
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
56
57
58
59
60
61
62
63
64
65
66

use std::cell::Cell;

#[derive(Default, Debug, Clone)]
/// A line that can be updated in the terminal. It is used in the [`Block`] struct.
pub struct InteractiveLine {
    pub content: String,
    pub relative_row: Cell<u8>,
}

impl InteractiveLine {
    /// Creates a new [`InteractiveLine`] with the given content.
    ///
    /// # Arguments
    ///
    /// * `content` - The content of the line.
    ///
    /// # Example
    ///
    /// ```
    /// use interm::interactive::Line;
    ///
    /// let line = Line::new("Hello, world!");
    ///
    /// assert_eq!(line.content, "Hello, world!");
    /// ```
    ///
    /// [`Block`]: struct.Block.html
    /// [`InteractiveLine`]: struct.InteractiveLine.html
    /// [`InteractiveLine::content`]: struct.InteractiveLine.html#structfield.content
    /// [`InteractiveLine::relative_row`]: struct.InteractiveLine.html#structfield.relative_row
    /// [`InteractiveLine::new`]: struct.InteractiveLine.html#method.new
    /// [`InteractiveLine::update_content`]: struct.InteractiveLine.html#method.update_content
    pub fn new(content: &str) -> Self {
        Self {
            content: content.to_owned(),
            ..Default::default()
        }
    }

    /// Updates the content of the line.
    /// # Arguments
    /// * `content` - The new content of the line.
    /// # Example
    /// ```
    /// use interm::interactive::Line;
    /// let mut line = Line::new("Hello, world!");
    /// line.update_content("Hello, world! 2");
    /// assert_eq!(line.content, "Hello, world! 2");
    /// ```
    /// [`Block`]: struct.Block.html
    /// [`InteractiveLine`]: struct.InteractiveLine.html
    /// [`InteractiveLine::content`]: struct.InteractiveLine.html#structfield.content
    /// [`InteractiveLine::relative_row`]: struct.InteractiveLine.html#structfield.relative_row
    /// [`InteractiveLine::new`]: struct.InteractiveLine.html#method.new
    /// [`InteractiveLine::update_content`]: struct.InteractiveLine.html#method.update_content
    ///
    /// # Notes
    /// This method is used in the [`Block::update_element`] method.
    pub fn update_content(&mut self, content: &str) {
        self.content = content.to_owned();
    }

    pub(crate) fn update_relative_row(&mut self, row: u8) {
        *self.relative_row.get_mut() = row;
    }
}