Struct io_lifetimes::OwnedHandle
1.63.0 · source · pub struct OwnedHandle { /* private fields */ }
Expand description
An owned handle.
This closes the handle on drop.
Note that it may have the value -1
, which in OwnedHandle
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.
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§
source§impl OwnedHandle
impl OwnedHandle
sourcepub fn try_clone(&self) -> Result<OwnedHandle, Error>
pub fn try_clone(&self) -> Result<OwnedHandle, Error>
Creates a new OwnedHandle
instance that shares the same underlying
object as the existing OwnedHandle
instance.
Trait Implementations§
source§impl AsHandle for OwnedHandle
impl AsHandle for OwnedHandle
source§fn as_handle(&self) -> BorrowedHandle<'_>
fn as_handle(&self) -> BorrowedHandle<'_>
Borrows the handle. Read more
source§impl AsRawHandle for OwnedHandle
impl AsRawHandle for OwnedHandle
source§impl Debug for OwnedHandle
impl Debug for OwnedHandle
source§impl Drop for OwnedHandle
impl Drop for OwnedHandle
source§impl From<Child> for OwnedHandle
impl From<Child> for OwnedHandle
source§fn from(child: Child) -> OwnedHandle
fn from(child: Child) -> OwnedHandle
Converts to this type from the input type.
source§impl From<ChildStderr> for OwnedHandle
impl From<ChildStderr> for OwnedHandle
source§fn from(child_stderr: ChildStderr) -> OwnedHandle
fn from(child_stderr: ChildStderr) -> OwnedHandle
Converts to this type from the input type.
source§impl From<ChildStdin> for OwnedHandle
impl From<ChildStdin> for OwnedHandle
source§fn from(child_stdin: ChildStdin) -> OwnedHandle
fn from(child_stdin: ChildStdin) -> OwnedHandle
Converts to this type from the input type.
source§impl From<ChildStdout> for OwnedHandle
impl From<ChildStdout> for OwnedHandle
source§fn from(child_stdout: ChildStdout) -> OwnedHandle
fn from(child_stdout: ChildStdout) -> OwnedHandle
Converts to this type from the input type.
source§impl From<File> for OwnedHandle
impl From<File> for OwnedHandle
source§fn from(file: File) -> OwnedHandle
fn from(file: File) -> OwnedHandle
Converts to this type from the input type.
source§impl<T> From<JoinHandle<T>> for OwnedHandle
impl<T> From<JoinHandle<T>> for OwnedHandle
source§fn from(join_handle: JoinHandle<T>) -> OwnedHandle
fn from(join_handle: JoinHandle<T>) -> OwnedHandle
Converts to this type from the input type.
source§impl FromRawHandle for OwnedHandle
impl FromRawHandle for OwnedHandle
source§unsafe fn from_raw_handle(handle: *mut c_void) -> OwnedHandle
unsafe fn from_raw_handle(handle: *mut c_void) -> OwnedHandle
Constructs a new I/O object from the specified raw handle. Read more
source§impl IntoRawHandle for OwnedHandle
impl IntoRawHandle for OwnedHandle
1.70.0 · source§impl IsTerminal for OwnedHandle
impl IsTerminal for OwnedHandle
source§fn is_terminal(&self) -> bool
fn is_terminal(&self) -> bool
Returns
true
if the descriptor/handle refers to a terminal/tty. Read moresource§impl TryFrom<HandleOrInvalid> for OwnedHandle
impl TryFrom<HandleOrInvalid> for OwnedHandle
§type Error = InvalidHandleError
type Error = InvalidHandleError
The type returned in the event of a conversion error.
source§fn try_from(
handle_or_invalid: HandleOrInvalid
) -> Result<OwnedHandle, InvalidHandleError>
fn try_from( handle_or_invalid: HandleOrInvalid ) -> Result<OwnedHandle, InvalidHandleError>
Performs the conversion.
source§impl TryFrom<HandleOrNull> for OwnedHandle
impl TryFrom<HandleOrNull> for OwnedHandle
§type Error = NullHandleError
type Error = NullHandleError
The type returned in the event of a conversion error.
source§fn try_from(
handle_or_null: HandleOrNull
) -> Result<OwnedHandle, NullHandleError>
fn try_from( handle_or_null: HandleOrNull ) -> Result<OwnedHandle, NullHandleError>
Performs the conversion.
impl FilelikeViewType for OwnedHandle
impl Send for OwnedHandle
impl Sync for OwnedHandle
Auto Trait Implementations§
Blanket Implementations§
source§impl<T> AsFilelike for Twhere
T: AsHandle,
impl<T> AsFilelike for Twhere T: AsHandle,
source§fn as_filelike(&self) -> BorrowedHandle<'_>
fn as_filelike(&self) -> BorrowedHandle<'_>
Borrows the reference. Read more
source§fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where
Target: FilelikeViewType,
fn as_filelike_view<Target>(&self) -> FilelikeView<'_, Target>where Target: FilelikeViewType,
Return a borrowing view of a resource which dereferences to a
&Target
. Read moresource§impl<T> AsRawFilelike for Twhere
T: AsRawHandle,
impl<T> AsRawFilelike for Twhere T: AsRawHandle,
source§fn as_raw_filelike(&self) -> *mut c_void
fn as_raw_filelike(&self) -> *mut c_void
Returns the raw value.
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> FromFilelike for Twhere
T: From<OwnedHandle>,
impl<T> FromFilelike for Twhere T: From<OwnedHandle>,
source§fn from_filelike(owned: OwnedHandle) -> T
fn from_filelike(owned: OwnedHandle) -> T
Constructs a new instance of
Self
from the given filelike object. Read moresource§fn from_into_filelike<Owned>(owned: Owned) -> Twhere
Owned: IntoFilelike,
fn from_into_filelike<Owned>(owned: Owned) -> Twhere Owned: IntoFilelike,
Constructs a new instance of
Self
from the given filelike object
converted from into_owned
. Read moresource§impl<T> FromHandle for Twhere
T: From<OwnedHandle>,
impl<T> FromHandle for Twhere T: From<OwnedHandle>,
source§fn from_handle(owned_handle: OwnedHandle) -> T
fn from_handle(owned_handle: OwnedHandle) -> T
👎Deprecated since 1.0.0:
FromHandle::from_handle
is replaced by From<OwnedHandle>::from
Constructs a new instance of
Self
from the given handle. Read moresource§fn from_into_handle<Owned: Into<OwnedHandle>>(into_owned: Owned) -> Selfwhere
Self: Sized + From<OwnedHandle>,
fn from_into_handle<Owned: Into<OwnedHandle>>(into_owned: Owned) -> Selfwhere Self: Sized + From<OwnedHandle>,
source§impl<T> FromRawFilelike for Twhere
T: FromRawHandle,
impl<T> FromRawFilelike for Twhere T: FromRawHandle,
source§unsafe fn from_raw_filelike(raw: *mut c_void) -> T
unsafe fn from_raw_filelike(raw: *mut c_void) -> T
Constructs
Self
from the raw value.source§impl<T> IntoFilelike for Twhere
T: Into<OwnedHandle>,
impl<T> IntoFilelike for Twhere T: Into<OwnedHandle>,
source§fn into_filelike(self) -> OwnedHandle
fn into_filelike(self) -> OwnedHandle
Consumes this object, returning the underlying filelike object.
source§impl<T> IntoHandle for Twhere
OwnedHandle: From<T>,
impl<T> IntoHandle for Twhere OwnedHandle: From<T>,
source§fn into_handle(self) -> OwnedHandle
fn into_handle(self) -> OwnedHandle
👎Deprecated since 1.0.0:
IntoHandle
is replaced by From<...> for OwnedHandle
or Into<OwnedHandle>
Consumes this object, returning the underlying handle. Read more
source§impl<T> IntoRawFilelike for Twhere
T: IntoRawHandle,
impl<T> IntoRawFilelike for Twhere T: IntoRawHandle,
source§fn into_raw_filelike(self) -> *mut c_void
fn into_raw_filelike(self) -> *mut c_void
Returns the raw value.