dsherret / crossterm-winapi

Crossterm Windows API Abstractions

Crossterm Windows API Abstractions

This crate provides some wrappers aground common used WinAPI functions.

The purpose of this library is originally meant for the crossterm, but could be used apart from it. Although, notice that it unstable right because some changes to the API could be expected.

Features

This crate provides some abstractions over reading input, console screen buffer, and handle.

The following WinApi calls:

• CONSOLE_SCREEN_BUFFER_INFO (used to extract information like cursor pos, terminal size etc.)
• HANDLE (the handle needed to run functions from WinApi)
• SetConsoleActiveScreenBuffer (activate an other screen buffer)
• Set/GetConsoleMode (e.g. console modes like disabling output)
• SetConsoleTextAttribute (eg. coloring)
• SetConsoleWindowInfo (changing the buffer location e.g. scrolling)
• FillConsoleOutputAttribute, FillConsoleOutputCharacter (used to replace some block of cells with a color or character.)
• SetConsoleInfo
• ReadConsoleW
• Semaphore object handling

Example

The examples repository has more complete and verbose examples.

Screen buffer information

use crossterm_winapi::{ScreenBuffer, Handle};

fn print_screen_buffer_information() {
    let screen_buffer = ScreenBuffer::current().unwrap();

    // get console screen buffer information
    let csbi = screen_buffer.info().unwrap();

    println!("cursor post: {:?}", csbi.cursor_pos());
    println!("attributes: {:?}", csbi.attributes());
    println!("terminal window dimentions {:?}", csbi.terminal_window());
    println!("terminal size {:?}", csbi.terminal_size());
}

Handle

use crossterm_winapi::{HandleType, Handle};

fn get_different_handle_types() {
    let out_put_handle = Handle::new(HandleType::OutputHandle).unwrap();
    let out_put_handle = Handle::new(HandleType::InputHandle).unwrap();
    let curr_out_put_handle = Handle::new(HandleType::CurrentOutputHandle).unwrap();
    let curr_out_put_handle = Handle::new(HandleType::CurrentInputHandle).unwrap();
}