BorrowedHandle in std::os::windows::io - Rust (original) (raw)
Struct 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. Seehere 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 BorrowedHandlerather than an OwnedHandle. It just makes a trivial copy of the raw handle, which is then borrowed under the same lifetime.
1.63.0 (const: 1.63.0) · Source
Returns 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.
1.63.0 · Source
Creates a new OwnedHandle instance that shares the same underlying object as the existing BorrowedHandle instance.