Struct std::os::windows::io::OwnedHandle

source · [−]

pub struct OwnedHandle { /* fields omitted */ }

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

This is supported on Windows only.

Expand description

An owned handle.

This closes the handle on drop.

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.

OwnedHandle uses CloseHandle to close its handle on drop. As such, it must not be used with handles to open registry keys which need to be closed with RegCloseKey instead.

Trait Implementations

source

impl AsHandle for OwnedHandle

source

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

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

Borrows the handle. Read more

source

impl AsRawHandle for OwnedHandle

source

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

source

impl Debug for OwnedHandle

source

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

Formats the value using the given formatter. Read more

source

impl Drop for OwnedHandle

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl From<Child> for OwnedHandle

source

fn from(child: Child) -> OwnedHandle

Performs the conversion.

source

impl From<ChildStderr> for OwnedHandle

source

fn from(child_stderr: ChildStderr) -> OwnedHandle

Performs the conversion.

source

impl From<ChildStdin> for OwnedHandle

source

fn from(child_stdin: ChildStdin) -> OwnedHandle

Performs the conversion.

source

impl From<ChildStdout> for OwnedHandle

source

fn from(child_stdout: ChildStdout) -> OwnedHandle

Performs the conversion.

source

impl From<File> for OwnedHandle

source

fn from(file: File) -> OwnedHandle

Performs the conversion.

source

impl<T> From<JoinHandle<T>> for OwnedHandle

source

fn from(join_handle: JoinHandle<T>) -> OwnedHandle

Performs the conversion.

source

impl From<OwnedHandle> for File

source

fn from(owned: OwnedHandle) -> Self

Performs the conversion.

source

impl From<OwnedHandle> for Stdio

source

fn from(handle: OwnedHandle) -> Stdio

Performs the conversion.

source

impl FromRawHandle for OwnedHandle

source

unsafe fn from_raw_handle(handle: RawHandle) -> Self

Constructs a new instance of Self from the given raw handle.

Safety

The resource pointed to by handle must be open and suitable for assuming ownership. The resource must not require any cleanup other than CloseHandle.

In particular, it must not be used with handles to open registry keys which need to be closed with RegCloseKey instead.

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

source