Struct crossterm_winapi::ConsoleMode

pub struct ConsoleMode { /* fields omitted */ }

A wrapper around a screen buffer, focusing on calls to get and set the console mode.

This wraps SetConsoleMode and GetConsoleMode.

Implementations

impl ConsoleMode

pub fn new() -> Result<ConsoleMode>

Create a new ConsoleMode instance.

This will use the standard output as its 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.

This wraps SetConsoleMode.

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

Get the console mode.

This function returns the lpMode.

This wraps GetConsoleMode.

Trait Implementations

impl Clone for ConsoleMode

fn clone(&self) -> ConsoleMode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ConsoleMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Handle> for ConsoleMode

fn from(handle: Handle) -> Self

Performs the conversion.