Skip to main content

Module windows

Module windows 

Expand description

Re-exports the Windows API abstraction from cssh-rs-platform-windows.

Existing daemon and client modules import from crate::utils::windows; the re-export preserves those paths while the implementation lives in the platform crate.

Modules§

api
Windows API abstraction layer for console and system operations.
traits
Windows implementations of the cssh-rs-platform traits.

Structs§

ConsolePaletteSnapshot
The console’s captured 16-entry palette plus its default text attribute (kept so the tint can locate the default text/background entries in color_table).
DefaultWindowsApi
Default implementation of WindowsApi that calls actual Windows APIs.
WindowsControlChannelClient
Client-side control channel backed by a Windows named pipe client.
WindowsControlChannelServer
Daemon-side control channel backed by a Windows named pipe server.

Constants§

KEY_EVENT
u16 representation of a KEY_EVENT.
MAX_WINDOW_TITLE_LENGTH
Maximum expected length of window title of a client window.

Traits§

WindowsApi
Trait for Windows API operations to enable mocking in tests.

Functions§

arrange_console
Changes size and position of the current console window using the provided API.
build_command_line
Build command line string for Windows process creation
clear_screen
Empties the console screen output buffer of the current console window using the provided API.
control_endpoint
Return the named-pipe path of the control channel owned by a daemon.
get_console_input_buffer
Returns a [HANDLE] to the [STD_INPUT_HANDLE] of the current process.
get_console_output_buffer
Returns a [HANDLE] to the [STD_OUTPUT_HANDLE] of the current process.
get_console_title
Returns the title of the current console window using the provided API.
is_windows_10
Detects if the current windows installation is Windows 10 or not using the provided API.
read_console_input
Returns a single [INPUT_RECORD] read from the current process stdinput using the provided API.
read_keyboard_input
Returns a single [INPUT_RECORD_0] where EventType == KEY_EVENT using the provided API.
set_console_border_color
Sets the border color of the current console window using the provided APIs.
set_console_color
Sets the back- and foreground color of the current console window using the provided API.
set_console_palette
Installs palette as the console’s 16-entry color table, leaving the rest of the buffer info as it currently is, and forces a repaint.
snapshot_console_palette
Snapshots the console’s 16-entry RGB palette and default text attribute for a later restore and for locating the default foreground/background entries the tint recolors.
tinted_palette
Derive the tinted palette for a state color: the captured palette with the console’s default-foreground and default-background entries remapped to the colors the legacy tint attribute’s foreground and background nibbles select. Recoloring palette entries (never the per-cell attributes) leaves VT/24-bit cells - which store their color outside the palette - untouched, so the full configured color applies without hiding the child’s own colored output.
utf16_buffer_to_string
Converts a UTF-16 buffer to a Rust String, filtering out null characters.