Struct io_lifetimes::OwnedHandle

pub struct OwnedHandle { /* private fields */ }

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.

Implementations

impl OwnedHandle

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

Creates a new OwnedHandle instance that shares the same underlying file handle 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, without taking any ownership.

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 FromHandle for OwnedHandle

fn from_handle(owned: OwnedHandle) -> Self

Constructs a new instance of Self from the given handle.

fn from_into_handle<Owned: IntoHandle>(into_owned: Owned) -> Self where
    Self: Sized, 

Constructs a new instance of Self from the given handle converted from into_owned.

impl FromRawHandle for OwnedHandle

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 raw must be open and suitable for assuming ownership.

impl IntoHandle for OwnedHandle

fn into_handle(self) -> OwnedHandle

Consumes this object, returning the underlying handle.

impl IntoRawHandle for OwnedHandle

fn into_raw_handle(self) -> RawHandle

Consumes this object, returning the raw underlying handle.

impl TryFrom<HandleOrInvalid> for OwnedHandle

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Send for OwnedHandle

impl Sync for OwnedHandle