Struct std::os::windows::io::BorrowedHandle

1.63.0 · source ·
pub struct BorrowedHandle<'handle> { /* private fields */ }
Available on Windows only.
Expand description

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.

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

This type’s .to_owned() implementation returns another BorrowedHandle rather than an OwnedHandle. It just makes a trivial copy of the raw handle, which is then borrowed under the same lifetime.

Implementations§

source§

impl BorrowedHandle<'_>

const: 1.63.0 · source

pub const unsafe fn borrow_raw(handle: RawHandle) -> Self

Return a BorrowedHandle holding the given raw handle.

§Safety

The resource pointed to by handle must be a valid open handle, it must remain open for the duration of the returned BorrowedHandle.

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.

source§

impl BorrowedHandle<'_>

source

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

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

Trait Implementations§

source§

impl AsHandle for BorrowedHandle<'_>

source§

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

Borrows the handle. Read more
source§

impl AsRawHandle for BorrowedHandle<'_>

source§

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle. Read more
source§

impl<'handle> Clone for BorrowedHandle<'handle>

source§

fn clone(&self) -> BorrowedHandle<'handle>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for BorrowedHandle<'_>

source§

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

Formats the value using the given formatter. Read more
1.70.0 · source§

impl IsTerminal for BorrowedHandle<'_>

source§

fn is_terminal(&self) -> bool

Returns true if the descriptor/handle refers to a terminal/tty. Read more
source§

impl<'handle> Copy for BorrowedHandle<'handle>

source§

impl Send for BorrowedHandle<'_>

source§

impl Sync for BorrowedHandle<'_>

Auto Trait Implementations§

§

impl<'handle> RefUnwindSafe for BorrowedHandle<'handle>

§

impl<'handle> Unpin for BorrowedHandle<'handle>

§

impl<'handle> UnwindSafe for BorrowedHandle<'handle>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.