Struct crossterm_winapi::ConsoleMode

pub struct ConsoleMode { /* fields omitted */ }

This abstracts away some WinaApi calls to set and get the console mode.

Wraps the underlying function call: SetConsoleMode link: [https://docs.microsoft.com/en-us/windows/console/setconsolemode]

Wraps the underlying function call: GetConsoleMode link: [https://docs.microsoft.com/en-us/windows/console/getconsolemode]

Methods

impl ConsoleMode

pub fn new() -> Result<ConsoleMode>

Create a new ConsoleMode instance.

This will use the STD_OUTPUT_HANDLE as default handle. When you explicitly want to specify the handle used for the function calls use ConsoleMode::from(handle) instead.

pub fn set_mode(&self, console_mode: u32) -> Result<()>

Set the console mode to the given console mode.

This function sets the dwMode.

Wraps the underlying function call: SetConsoleMode link: [https://docs.microsoft.com/en-us/windows/console/setconsolemode]

pub fn mode(&self) -> Result<u32>

Get the console mode.

This function returns the lpMode.

Wraps the underlying function call: GetConsoleMode link: [https://docs.microsoft.com/en-us/windows/console/getconsolemode]

Trait Implementations

impl From<Handle> for ConsoleMode

fn from(handle: Handle) -> Self

Performs the conversion.