Struct io_lifetimes::BorrowedHandle

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

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, and it is never null.

Note that it may have the value [INVALID_HANDLE_VALUE]. See here for the full story.

Implementations

impl BorrowedHandle<'_>

pub unsafe fn borrow_raw_handle(raw: RawHandle) -> Self

Return a BorrowedHandle holding the given raw handle.

Safety

The resource pointed to by raw must remain open for the duration of the returned BorrowedHandle, and it must not be null.

Trait Implementations

impl AsHandle for BorrowedHandle<'_>

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

Borrows the handle.

impl AsRawHandle for BorrowedHandle<'_>

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

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<'_>