Struct cursormatrix::Term

pub struct Term {
    pub cursor: Cursor,
    pub matrix: Matrix,
    pub terminfo: TermInfo,
    pub xlimit: Option<usize>,
    pub fg: Vec<(u8, u8, u8)>,
    pub bg: Vec<(u8, u8, u8)>,
    // some fields omitted
}

The main struct of cursormatrix crate

Example usage:

use cursormatrix::{Direction, Event, Input, Term};

fn handle_event(ev: &Event, term: &mut Term) -> bool {
    match ev {
        &Event::Ctrl(Input::Chars(ref s)) => match s.as_str() {
            "C" => return false,
            _ => (),
        },
        &Event::Raw(Input::Arrow(Direction::Up)) => term.move_up().unwrap(),
        &Event::Raw(Input::Arrow(Direction::Down)) => term.move_down().unwrap(),
        &Event::Raw(Input::BackSpace) => term.cursor.backspace().unwrap(),
        &Event::Raw(Input::Chars(ref s)) => term.print(&s).unwrap(),
        &Event::TermSize(w, h) => term.matrix.refresh(w, h),
        _ => (),
    }
    true
}

fn main() {
    let (mut term, erx) = Term::with_input(true).expect("term");

    term.print("edit").unwrap();
    loop {
        if match erx.recv() {
            Ok(ev) => !handle_event(&ev, &mut term),
            Err(_) => false,
        } {
            break;
        }
    }
}

Fields

cursor: Cursor

matrix: Matrix

terminfo: TermInfo

xlimit: Option<usize>

fg: Vec<(u8, u8, u8)>

bg: Vec<(u8, u8, u8)>

Implementations

impl Term

pub fn from_cjk(cjk: bool) -> Result<Self, Error>

pub fn with_input(cjk: bool) -> Result<(Self, Receiver<Event>), Error>

pub fn clear(&mut self) -> Result<(), Error>

pub fn width_char(&self, c: char) -> usize

pub fn width_str(&self, s: &str) -> usize

pub fn print(&mut self, s: &str) -> Result<(), Error>

pub fn push_colors(&mut self, fg: (u8, u8, u8), bg: (u8, u8, u8))

pub fn pop_colors(
    &mut self,
    fg: bool,
    bg: bool
) -> (Option<(u8, u8, u8)>, Option<(u8, u8, u8)>)

pub fn cprint(
    &mut self,
    s: &str,
    fg: Option<(u8, u8, u8)>,
    bg: Option<(u8, u8, u8)>
) -> Result<(), Error>

pub fn move_to(&mut self, x: usize, y: usize) -> Result<(), Error>

pub fn move_up(&mut self) -> Result<(), Error>

pub fn move_down(&mut self) -> Result<(), Error>

pub fn move_left(&mut self) -> Result<(), Error>

pub fn move_right(&mut self) -> Result<(), Error>

pub fn move_home(&mut self) -> Result<(), Error>

pub fn move_end(&mut self) -> Result<(), Error>

pub fn move_top(&mut self) -> Result<(), Error>

pub fn move_bottom(&mut self) -> Result<(), Error>

Trait Implementations

impl Drop for Term

pub fn drop(&mut self)

Executes the destructor for this type.