Struct OwnedHandle

#[repr(transparent)]
pub struct OwnedHandle {
    handle: RawHandle,
}

Available on Windows only.

An owned handle.

This closes the handle on drop.

Note that it may have the value -1, which in OwnedHandle 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.

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.

Fields

handle: RawHandle

Implementations

impl OwnedHandle

pub fn try_clone(&self) -> Result<Self>

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

Trait Implementations

impl AsHandle for OwnedHandle

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

Borrows the handle.

impl AsRawHandle for OwnedHandle

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle.

impl Debug for OwnedHandle

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

Formats the value using the given formatter.

impl Drop for OwnedHandle

fn drop(&mut self)

Executes the destructor for this type.

impl From<Child> for OwnedHandle

fn from(child: Child) -> OwnedHandle

Takes ownership of a Child’s process handle.

impl From<ChildStderr> for OwnedHandle

fn from(child_stderr: ChildStderr) -> OwnedHandle

Takes ownership of a ChildStderr’s file handle.

impl From<ChildStdin> for OwnedHandle

fn from(child_stdin: ChildStdin) -> OwnedHandle

Takes ownership of a ChildStdin’s file handle.

impl From<ChildStdout> for OwnedHandle

fn from(child_stdout: ChildStdout) -> OwnedHandle

Takes ownership of a ChildStdout’s file handle.

impl From<File> for OwnedHandle

fn from(file: File) -> OwnedHandle

Takes ownership of a File’s underlying file handle.

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

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

Converts to this type from the input type.

impl From<OwnedHandle> for ChildStderr

Creates a ChildStderr from the provided OwnedHandle.

The provided handle must be asynchronous, as reading and writing from and to it is implemented using asynchronous APIs.

fn from(handle: OwnedHandle) -> ChildStderr

Converts to this type from the input type.

impl From<OwnedHandle> for ChildStdin

Creates a ChildStdin from the provided OwnedHandle.

The provided handle must be asynchronous, as reading and writing from and to it is implemented using asynchronous APIs.

fn from(handle: OwnedHandle) -> ChildStdin

Converts to this type from the input type.

impl From<OwnedHandle> for ChildStdout

Creates a ChildStdout from the provided OwnedHandle.

The provided handle must be asynchronous, as reading and writing from and to it is implemented using asynchronous APIs.

fn from(handle: OwnedHandle) -> ChildStdout

Converts to this type from the input type.

impl From<OwnedHandle> for File

fn from(owned: OwnedHandle) -> Self

Returns a File that takes ownership of the given handle.

impl From<OwnedHandle> for PipeReader

fn from(owned_handle: OwnedHandle) -> Self

Converts to this type from the input type.

impl From<OwnedHandle> for PipeWriter

fn from(owned_handle: OwnedHandle) -> Self

Converts to this type from the input type.

impl From<OwnedHandle> for Stdio

fn from(handle: OwnedHandle) -> Stdio

Takes ownership of a handle and returns a Stdio that can attach a stream to it.

impl From<PipeReader> for OwnedHandle

fn from(pipe: PipeReader) -> Self

Converts to this type from the input type.

impl From<PipeWriter> for OwnedHandle

fn from(pipe: PipeWriter) -> Self

Converts to this type from the input type.

impl FromRawHandle for OwnedHandle

unsafe fn from_raw_handle(handle: RawHandle) -> Self

Constructs a new I/O object from the specified raw handle.

impl IntoRawHandle for OwnedHandle

fn into_raw_handle(self) -> RawHandle

Consumes this object, returning the raw underlying handle.

impl IsTerminal for OwnedHandle

fn is_terminal(&self) -> bool

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

impl TryFrom<HandleOrInvalid> for OwnedHandle

type Error = InvalidHandleError

The type returned in the event of a conversion error.

fn try_from( handle_or_invalid: HandleOrInvalid, ) -> Result<Self, InvalidHandleError>

Performs the conversion.

impl TryFrom<HandleOrNull> for OwnedHandle

type Error = NullHandleError

The type returned in the event of a conversion error.

fn try_from(handle_or_null: HandleOrNull) -> Result<Self, NullHandleError>

Performs the conversion.

impl Sealed for OwnedHandle

impl Send for OwnedHandle

impl Sync for OwnedHandle