Struct winapi_util::HandleRef

pub struct HandleRef(_);

Represents a borrowed and valid Windows handle to a file-like object, such as stdin/stdout/stderr or an actual file.

When a borrowed handle is dropped, then the underlying raw handle is not closed. To get an owned handle, use Handle.

Methods

impl HandleRef

pub fn stdin() -> HandleRef

Create a borrowed handle to stdin.

When the returned handle is dropped, stdin is not closed.

pub fn stdout() -> HandleRef

Create a handle to stdout.

When the returned handle is dropped, stdout is not closed.

pub fn stderr() -> HandleRef

Create a handle to stderr.

When the returned handle is dropped, stderr is not closed.

pub fn from_file(file: &File) -> HandleRef

Create a borrowed handle to the given file.

When the returned handle is dropped, the file is not closed.

pub unsafe fn from_raw_handle(handle: RawHandle) -> HandleRef

Create a borrowed handle from the given raw handle.

Note that unlike the FromRawHandle trait, this constructor does not consume ownership of the given handle. That is, when the borrowed handle created by this constructor is dropped, the underlying handle will not be closed.

Safety

This is unsafe because there is no guarantee that the given raw handle is a valid handle. The caller must ensure this is true before invoking this constructor.

pub fn as_file(&self) -> &File

Return this handle as a standard File reference.

pub fn as_file_mut(&mut self) -> &mut File

Return this handle as a standard File mutable reference.

Trait Implementations

impl Debug for HandleRef

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

Formats the value using the given formatter.

impl AsRawHandle for HandleRef

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

impl Clone for HandleRef

fn clone(&self) -> HandleRef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsHandleRef for HandleRef

fn as_handle_ref(&self) -> HandleRef

A borrowed handle that wraps the raw handle of the Self object.

fn as_raw(&self) -> RawHandle

A convenience routine for extracting a HandleRef from Self, and then extracting a raw handle from the HandleRef.