owen 0.0.1

Terminal User Interface 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54

use std::ops::Add;

#[derive(Copy, Clone, PartialEq, Eq)]
// A structure used to determine the position of an object on the terminal.
// The row and column position start at 0 from the top left corner of the terminal
pub struct Position {
    // The amount of rows from the top of the terminal
    pub row: u16,
    // The amount of columns from the left side of the terminal.
    pub column: u16,
}

impl Position {
    pub fn from(row: u16, column: u16) -> Position {
        Position { row, column }
    }
}

// Used to offset something
impl Add for Position {
    type Output = Position;

    fn add(self, rhs: Self) -> Self::Output {
        Position {
            row: self.row + rhs.row,
            column: self.column + rhs.column,
        }
    }
}

#[derive(Copy, Clone, PartialEq, Eq)]
// A structure to determine the size of an object on the terminal.
// The amount of rows and columns start at 1.
pub struct Size {
    // Vertical Size
    pub rows: u16,
    // Horizontal Size
    pub columns: u16,
}

impl Size {
    pub fn from(rows: u16, columns: u16) -> Size {
        Size { rows, columns }
    }
}

impl Size {
    // The amount of space that the object takes up
    pub fn area(&self) -> u16 {
        self.rows * self.columns
    }
}

// TODO: Write arrangement and constraints