Struct crossterm_winapi::Handle

#[repr(transparent)]
pub struct Handle { /* fields omitted */ }

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

Methods

impl Handle

pub fn new(handle: HandleType) -> Result<Handle>

pub unsafe fn from_raw(handle: HANDLE) -> Self

Construct a handle from a raw handle.

Safety

This is unsafe since there is not guarantee that the underlying HANDLE is thread-safe to implement Send and Sync. Most HANDLE's however, are thread safe.

pub fn current_out_handle() -> Result<Handle>

Get the handle of the active screen buffer. When using multiple screen buffers this will always point to the to the current screen output buffer.

On success this function returns the HANDLE to STD_OUTPUT_HANDLE.

This function uses CONOUT$ to create a file handle to the current output buffer.

Wraps the underlying function call: CreateFileW link: [https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-createfilew]

pub fn current_in_handle() -> Result<Handle>

Get the handle of the active input screen buffer. When using multiple screen buffers this will always point to the to the current screen input buffer.

On success this function returns the HANDLE to STD_INPUT_HANDLE.

This function uses CONIN$ to create a file handle to the current input buffer.

Wraps the underlying function call: CreateFileW link: [https://docs.microsoft.com/en-us/windows/desktop/api/fileapi/nf-fileapi-createfilew]

pub fn output_handle() -> Result<Handle>

Get the handle of the output screen buffer.

On success this function returns the HANDLE to STD_OUTPUT_HANDLE.

Wraps the underlying function call: GetStdHandle whit argument STD_OUTPUT_HANDLE link: [https://docs.microsoft.com/en-us/windows/console/getstdhandle]

pub fn input_handle() -> Result<Handle>

Get the handle of the input screen buffer.

On success this function returns the HANDLE to STD_INPUT_HANDLE.

Wraps the underlying function call: GetStdHandle whit argument STD_INPUT_HANDLE link: [https://docs.microsoft.com/en-us/windows/console/getstdhandle]

pub fn is_valid_handle(handle: &HANDLE) -> bool

Checks if the console handle is an invalid handle value.

This is done by checking if the passed HANDLE is equal to INVALID_HANDLE_VALUE

Trait Implementations

impl Send for Handle

impl Sync for Handle

impl From<Handle> for Console

fn from(handle: Handle) -> Self

Create a Console instance who's functions will be executed on the the given Handle

impl From<Handle> for ConsoleMode

fn from(handle: Handle) -> Self

Performs the conversion.

impl From<Handle> for ScreenBuffer

fn from(handle: Handle) -> Self

Performs the conversion.

impl Clone for Handle

fn clone(&self) -> Handle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for Handle

type Target = HANDLE

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.