Struct std::os::windows::io::BorrowedHandle

pub struct BorrowedHandle<'handle> { /* private fields */ }

Available on Windows only.

A borrowed handle.

This has a lifetime parameter to tie it to the lifetime of something that owns the handle.

This uses repr(transparent) and has the representation of a host handle, so it can be used in FFI in places where a handle is passed as an argument, it is not captured or consumed.

Note that it may have the value -1, which in BorrowedHandle always represents a valid handle value, such as the current process handle, and not INVALID_HANDLE_VALUE, despite the two having the same value. See here for the full story.

And, it may have the value NULL (0), which can occur when consoles are detached from processes, or when windows_subsystem is used.

This type’s .to_owned() implementation returns another BorrowedHandle rather than an OwnedHandle. It just makes a trivial copy of the raw handle, which is then borrowed under the same lifetime.

Implementations

impl BorrowedHandle<'_>

pub const unsafe fn borrow_raw(handle: RawHandle) -> Self

Return a BorrowedHandle holding the given raw handle.

Safety

The resource pointed to by handle must be a valid open handle, it must remain open for the duration of the returned BorrowedHandle.

Note that it may have the value INVALID_HANDLE_VALUE (-1), which is sometimes a valid handle value. See here for the full story.

And, it may have the value NULL (0), which can occur when consoles are detached from processes, or when windows_subsystem is used.

impl BorrowedHandle<'_>

pub fn try_clone_to_owned(&self) -> Result<OwnedHandle>

Creates a new OwnedHandle instance that shares the same underlying object as the existing BorrowedHandle instance.

Trait Implementations

impl AsHandle for BorrowedHandle<'_>

fn as_handle(&self) -> BorrowedHandle<'_>

Borrows the handle.

impl AsRawHandle for BorrowedHandle<'_>

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle.

impl<'handle> Clone for BorrowedHandle<'handle>

fn clone(&self) -> BorrowedHandle<'handle>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorrowedHandle<'_>

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

Formats the value using the given formatter.

impl IsTerminal for BorrowedHandle<'_>

fn is_terminal(&self) -> bool

Returns true if the descriptor/handle refers to a terminal/tty.

impl<'handle> Copy for BorrowedHandle<'handle>

impl Send for BorrowedHandle<'_>

impl Sync for BorrowedHandle<'_>