Struct io_lifetimes::OwnedHandle

#[repr(transparent)]
pub struct OwnedHandle { /* fields omitted */ }

An owned handle.

This closes the handle on drop.

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 a consumed argument or returned as an owned value, and is never null.

Note that it may have the value [INVALID_HANDLE_VALUE]. See here for the full story. For APIs like CreateFileW which report errors with INVALID_HANDLE_VALUE instead of null, use OptionFileHandle instead of Option<OwnedHandle>.

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 From<OwnedHandle> for OptionFileHandle

fn from(owned: OwnedHandle) -> Self

Performs the conversion.

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(raw: 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<OptionFileHandle> for OwnedHandle

type Error = ()

The type returned in the event of a conversion error.

fn try_from(option: OptionFileHandle) -> Result<Self, ()>

Performs the conversion.

impl Send for OwnedHandle

impl Sync for OwnedHandle