Struct HSTD

pub struct HSTD(/* private fields */);

Available on crate feature kernel only.

Handle to a standard device. Originally just a HANDLE.

Implementations

impl HSTD

pub const unsafe fn from_ptr(p: *mut c_void) -> Self

Constructs a new handle object by wrapping a pointer.

This method can be used as an escape hatch to interoperate with other libraries.

Safety

Be sure the pointer has the correct type and isn’t owned by anyone else, otherwise you may cause memory access violations.

pub const unsafe fn raw_copy(&self) -> Self

Returns a raw copy of the underlying handle pointer.

Safety

As the name implies, raw_copy returns a raw copy of the handle, so closing one of the copies won’t close the others. This means a handle can be used after it has been closed, what can lead to errors and undefined behavior. Even worse: sometimes Windows reuses handle values, so you can call a method on a completely different handle type, what can be catastrophic.

However, in some cases the Windows API demands a copy of the handle – raw_copy is an escape hatch to fill this gap.

pub const unsafe fn as_mut(&mut self) -> &mut *mut c_void

Returns a mutable reference to the underlying raw pointer.

This method can be used as an escape hatch to interoperate with other libraries.

Safety

This method exposes the raw pointer used by raw Windows calls. It’s an opaque pointer to an internal Windows structure, and no dereferencings should be attempted.

pub const fn ptr(&self) -> *mut c_void

Returns the underlying raw pointer.

This method exposes the raw pointer used by raw Windows calls. It’s an opaque pointer to an internal Windows structure, and no dereferencings should be attempted.

This method can be used as an escape hatch to interoperate with other libraries.

impl HSTD

pub fn FlushConsoleInputBuffer(&self) -> SysResult<()>

FlushConsoleInputBuffer function.

pub fn GetConsoleMode(&self) -> SysResult<CONSOLE>

GetConsoleMode function.

pub fn GetStdHandle(std_handle: STD_HANDLE) -> SysResult<CloseHandleGuard<HSTD>>

GetStdHandle function.

pub fn ReadConsole( &self, buffer: &mut WString, input_control: Option<&CONSOLE_READCONSOLE_CONTROL>, ) -> SysResult<u32>

ReadConsole function.

Returns the number of chars actually written.

Examples

use winsafe::{self as w, prelude::*, co};

let hstd = w::HSTD::GetStdHandle(co::STD_HANDLE::INPUT)?;

let mut buffer = w::WString::new_alloc_buf(2048);
hstd.ReadConsole(&mut buffer, None)?;

let text = buffer.to_string();

pub fn SetConsoleMode(&self, mode: CONSOLE) -> SysResult<()>

SetConsoleMode function.

pub fn WriteConsole(&self, text: &str) -> SysResult<u32>

WriteConsole function.

Returns the number of chars actually written.

Trait Implementations

impl Debug for HSTD

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

Formats the value using the given formatter.

impl Display for HSTD

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

Formats the value using the given formatter.

impl Handle for HSTD

const NULL: Self

The null, uninitialized handle; equals to 0.

const INVALID: Self

The invalid handle; equals to -1.

unsafe fn from_ptr(p: *mut c_void) -> Self

Constructs a new handle object by wrapping a pointer.

unsafe fn raw_copy(&self) -> Self

Returns a raw copy of the underlying handle pointer.

unsafe fn as_mut(&mut self) -> &mut *mut c_void

Returns a mutable reference to the underlying raw pointer.

fn ptr(&self) -> *mut c_void

Returns the underlying raw pointer.

fn as_opt(&self) -> Option<&Self>

Returns None if the handle is null or invalid, otherwise returns Some(&self).

impl Hash for HSTD

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for HSTD

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

Formats the value using the given formatter.

impl PartialEq for HSTD

fn eq(&self, other: &HSTD) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl UpperHex for HSTD

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

Formats the value using the given formatter.

impl Eq for HSTD

impl Send for HSTD

impl StructuralPartialEq for HSTD