Win32Console

Expose functions to interact with the windows console from Rust.

See: https://docs.microsoft.com/en-us/windows/console/console-functions

Usage

Add this to your Cargo.toml: toml [dependencies] win32console = ""

Example

```rust use win32console::console::WinConsole; use win32console::structs::input::*;

fn main() { // Virtual key codes // https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes const ESCAPE : u16 = 0x1B; const BACKSPACE: u16 = 0x08; const ENTER : u16 = 0x0D; const SPACE : u16 = 0x20;

loop{
    // Get the current input event
    if let KeyEvent(key) = WinConsole::input().read_single_input().unwrap(){
        // Only check for key down events
        if key.key_down{
            let char_value = key.u_char;
            // Write only if is alphanumeric or punctuation
            if char_value.is_ascii_alphanumeric() || char_value.is_ascii_punctuation(){
                let mut value : [u8; 1] = [0];
                char_value.encode_utf8(&mut value);
                WinConsole::output().write_utf8(&value);
            }
            else{
                match key.virtual_key_code {
                    ESCAPE => { break; },
                    ENTER => { WinConsole::output().write_utf8("\n".as_bytes()); }
                    SPACE => { WinConsole::output().write_utf8(" ".as_bytes()); },
                    BACKSPACE => { WinConsole::output().write_utf8(b"\x08 \x08"); },
                    _ => {}
                }
            }
        }
    }
}

} ```

Implementation

List of the native methods of Wincon implemented in this library:

Native Function :----------------------- AddConsoleAlias AllocConsole AttachConsole ClosePseudoConsole CreatePseudoConsole CreateConsoleScreenBuffer FillConsoleOutputAttribute FillConsoleOutputCharacter FlushConsoleInputBuffer FreeConsole GenerateConsoleCtrlEvent GetConsoleAlias GetConsoleAliases GetConsoleAliasesLength GetConsoleAliasExes GetConsoleAliasExesLength GetConsoleCP GetConsoleCursorInfo GetConsoleDisplayMode GetConsoleFontSize GetConsoleHistoryInfo GetConsoleMode GetConsoleOriginalTitle GetConsoleOutputCP GetConsoleProcessList GetConsoleScreenBufferInfo GetConsoleScreenBufferInfoEx GetConsoleSelectionInfo GetConsoleTitle GetConsoleWindow GetCurrentConsoleFont GetCurrentConsoleFontEx GetLargestConsoleWindowSize GetNumberOfConsoleInputEvents GetNumberOfConsoleMouseButtons GetStdHandle HandlerRoutine PeekConsoleInput ReadConsole ReadConsoleInput ReadConsoleOutput ReadConsoleOutputAttribute ReadConsoleOutputCharacter ResizePseudoConsole ScrollConsoleScreenBuffer SetConsoleActiveScreenBuffer SetConsoleCP SetConsoleCtrlHandler SetConsoleCursorInfo SetConsoleCursorPosition SetConsoleDisplayMode SetConsoleHistoryInfo SetConsoleMode SetConsoleOutputCP SetConsoleScreenBufferInfoEx SetConsoleScreenBufferSize SetConsoleTextAttribute SetConsoleTitle SetConsoleWindowInfo SetCurrentConsoleFontEx SetStdHandle WriteConsole WriteConsoleInput WriteConsoleOutput WriteConsoleOutputAttribute WriteConsoleOutputCharacter | WinConsole Function | Description
----------|:------------------------------|:----------------------------------------------------------------------------------------------------------------------------- | - | Defines a console alias for the specified executable.
| allocconsole | Allocates a new console for the calling process.
| attachconsole | Attaches the calling process to the console of the specified process.
| - | Closes a pseudoconsole from the given handle.
| - | Allocates a new pseudoconsole for the calling process.
| createconsolebuffer | Creates a console screen buffer.
| fillwithattribute | Sets the text and background color attributes for a specified number of character cells.
| fillwithchar | Writes a character to the console screen buffer a specified number of times.
| flush | Flushes the console input buffer.
| freeconsole | Detaches the calling process from its console.
| - | Sends a specified signal to a console process group that shares the console associated with the calling process.
| - | Retrieves the specified alias for the specified executable.
| - | Retrieves all defined console aliases for the specified executable.
| - | Returns the size, in bytes, of the buffer needed to store all of the console aliases for the specified executable.
| - | Retrieves the names of all executables with console aliases defined.
| - | Returns the size, in bytes, of the buffer needed to store the names of all executables that have console aliases defined.
| getinputcodepoint | Retrieves the input code page used by the console associated with the calling process.
| getcursorinfo | Retrieves information about the size and visibility of the cursor for the specified console screen buffer.
| getdisplaymode | Retrieves the display mode of the current console.
| getfontsize | Retrieves the size of the font used by the specified console screen buffer.
| gethistoryinfo | Retrieves the history settings for the calling process's console.
| getmode | Retrieves the current input mode of a console's input buffer or the current output mode of a console screen buffer.
| getoriginaltitle | Retrieves the original title for the current console window.
| getinputcodepage | Retrieves the output code page used by the console associated with the calling process.
| getprocesslist | Retrieves a list of the processes attached to the current console.
| getscreenbufferinfo | Retrieves information about the specified console screen buffer.
| getscreenbufferinfoex | Retrieves extended information about the specified console screen buffer.
| getselectioninfo | Retrieves information about the current console selection.
| gettitle | Retrieves the title for the current console window.
| getwindow | Retrieves the window handle used by the console associated with the calling process.
| getfont | Retrieves information about the current console font.
| getfontex | Retrieves extended information about the current console font.
| getlargestwindowsize | Retrieves the size of the largest possible console window.
| getnumberofinputevents | Retrieves the number of unread input records in the console's input buffer.
| getnumberofmousebuttons | Retrieves the number of buttons on the mouse used by the current console.
| getstdhandle | Retrieves a handle for the standard input, standard output, or standard error device.
| - | An application-defined function used with the SetConsoleCtrlHandler function.
| peekinput | Reads data from the specified console input buffer without removing it from the buffer.
| readutf8/readutf16 | Reads character input from the console input buffer and removes it from the buffer.
| readinput | Reads data from a console input buffer and removes it from the buffer.
| readoutput | Reads character and color attribute data from a rectangular block of character cells in a console screen buffer.
| readoutputattribute | Copies a specified number of foreground and background color attributes from consecutive cells of a console screen buffer.
| readoutputcharacter | Copies a number of characters from consecutive cells of a console screen buffer.
| - | Resizes the internal buffers for a pseudoconsole to the given size.
| scrollscreenbuffer | Moves a block of data in a screen buffer.
| setactivescreenbuffer | Sets the specified screen buffer to be the currently displayed console screen buffer.
| setinputcodepage | Sets the input code page used by the console associated with the calling process.
| - | Adds or removes an application-defined HandlerRoutine from the list of handler functions for the calling process.
| setcursorinfo | Sets the size and visibility of the cursor for the specified console screen buffer.
| setcursorposition | Sets the cursor position in the specified console screen buffer.
| setdisplaymode | Sets the display mode of the specified console screen buffer.
| sethistoryinfo | Sets the history settings for the calling process's console.
| setmode | Sets the input mode of a console's input buffer or the output mode of a console screen buffer.
| setoutputcodepage | Sets the output code page used by the console associated with the calling process.
| setscreenbufferinfo | Sets extended information about the specified console screen buffer.
| setscreenbuffersize | Changes the size of the specified console screen buffer.
| settextattribute | Sets the foreground (text) and background color attributes of characters written to the console screen buffer.
| settitle | Sets the title for the current console window.
| setwindowinfo | Sets the current size and position of a console screen buffer's window.
| setfontex | Sets extended information about the current console font.
| setstdhandle | Sets the handle for the standard input, standard output, or standard error device.
| writeutf8/writeutf16 | Writes a character string to a console screen buffer beginning at the current cursor location.
| writeinput | Writes data directly to the console input buffer.
| writeoutput | Writes character and color attribute data to a specified rectangular block of character cells in a console screen buffer.
| writeoutputattribute | Copies a number of foreground and background color attributes to consecutive cells of a console screen buffer.
| writeoutput_character | Copies a number of characters to consecutive cells of a console screen buffer.

Also provides functions as: ```c++ // Clears the screen WinConsole::output().clear();

// Reads a 'String' from the console WinConsole::input().read_string();

// Makes and tone sound WinConsole::beep(u32, u32);

// Sets the foreground color WinConsole::output().setforegroundcolor(ConsoleColor);

// Sets the background color WinConsole::output().setbackgroundcolor(ConsoleColor);

// Gets the foreground color WinConsole::output().getforegroundcolor();

// Gets the background color WinConsole::output().getbackgroundcolor(); ```