zui-core 0.0.3

A Terminal UI Library, Written in Rust
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

#![warn(clippy::all, clippy::cargo)]
#![allow(clippy::should_implement_trait)]

//! # zui
//!
//! `zui` is a terminal UI library in Rust. It works on Unix-like platforms and ANSI terminals, with Windows support
//! planned. It has features like dynamic resizing, async stdin, and more
//!
//! `zui` is very simple, yet powerful. To see examples on how to use `zui`, visit:
//! <https://git.dumrich.com/zui/tree/examples>

// Define Modules
pub mod color;
pub mod key;
pub mod style;
pub mod term;

// Imports
use std::fmt;

// Define Ansi struct
/// Define ANSI struct. Meant for private use
#[derive(Debug, Clone)]
pub struct Ansi {
    pub value: String,
}

impl Ansi {
    // Associated method
    pub fn from_str(input: String) -> Ansi {
        Ansi { value: input }
    }
}

// Allow displaying Ansi struct
impl fmt::Display for Ansi {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.value)
    }
}

/// Convert string to Ansi type
pub trait ToAnsi {
    fn to_ansi(&self) -> Ansi;
}