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

#[repr(transparent)]
pub struct BorrowedHandle<'handle> { /* private fields */ }

🔬 This is a nightly-only experimental API. (io_safety #87074)

This is supported 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 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.

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 unsafe fn borrow_raw(handle: RawHandle) -> Self

🔬 This is a nightly-only experimental API. (io_safety #87074)

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.

Trait Implementations

impl AsHandle for BorrowedHandle<'_>

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

🔬 This is a nightly-only experimental API. (io_safety #87074)

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<'handle> Copy for BorrowedHandle<'handle>

impl Send for BorrowedHandle<'_>

impl Sync for BorrowedHandle<'_>