Struct unsafe_io::UnsafeHandle

#[repr(transparent)]pub struct UnsafeHandle(_);

A non-owning unsafe I/O handle.

On Posix-ish platforms this is just a RawFd. On Windows it is a minimal abstraction over RawHandle and RawSocket. Similar to Rust raw pointers, it is considered safe to construct these, but unsafe to do any I/O with them (effectively dereferencing them).

Implementations

impl UnsafeHandle

#[must_use]pub const unsafe fn as_readable(self) -> UnsafeReadable

Obtain self with a type that implements Read.

Safety

The resulting UnsafeReadable value must not outlive the underlying resource.

Also, callers should avoid mixing uses of UnsafeReadable with the type's Read or Write implementations if the type uses buffering, as for example async_std::fs::File does.

#[must_use]pub const unsafe fn as_writeable(self) -> UnsafeWriteable

Obtain self with a type that implements Write.

Safety

The resulting UnsafeWriteable value must not outlive the underlying resource.

Also, callers should avoid mixing uses of UnsafeWriteable with the type's Read or Write implementation if the type uses buffering, as for example async_std::fs::File does.

#[must_use]pub unsafe fn eq(self, other: Self) -> bool

UnsafeHandle doesn't implement Eq or PartialEq because comparison is undefined for dangling handles.

Safety

Both self and other must outlive their underlying resources.

#[must_use]pub const fn from_raw_fd(raw_fd: RawFd) -> Self

Like FromRawFd::from_raw_fd, but isn't unsafe because it doesn't imply a dereference.

Trait Implementations

impl AsRawFd for UnsafeHandle

UnsafeHandle doesn't own its handle, but AsRawFd doesn't require any guarantees about lifetimes, so it's safe to implement. This is similar to how RawFd implements AsRawFd (see the raw_fd_reflexive_traits trait implementations in std).

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Clone for UnsafeHandle

fn clone(&self) -> UnsafeHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for UnsafeHandle

impl Debug for UnsafeHandle

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

Formats the value using the given formatter.

impl FromRawFd for UnsafeHandle

UnsafeHandle doesn't own its handle; see the comments for impl AsRawFd for UnsafeHandle.

unsafe fn from_raw_fd(raw_fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl FromUnsafeHandle for UnsafeHandle

UnsafeHandle doesn't own its handle; see the comments for impl AsRawFd for UnsafeHandle.

unsafe fn from_unsafe_handle(unsafe_handle: UnsafeHandle) -> Self

Constructs a new instance of Self from the given unsafe handle.

impl IntoRawFd for UnsafeHandle

UnsafeHandle doesn't own its handle; see the comments for impl AsRawFd for UnsafeHandle.

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.