Trait base::descriptor::AsRawDescriptor

pub trait AsRawDescriptor {
    // Required method
    fn as_raw_descriptor(&self) -> RawDescriptor;
}

Trait for returning the underlying raw descriptor, without giving up ownership of the descriptor.

Required Methods

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

Since the descriptor is still owned by the provider, callers should not assume that it will remain open for longer than the immediate call of this method. In particular, it is a dangerous practice to store the result of this method for future use: instead, it should be used to e.g. obtain a raw descriptor that is immediately passed to a system call.

If you need to use the descriptor for a longer time (and particularly if you cannot reliably track the lifetime of the providing object), you should probably consider using SafeDescriptor (possibly along with IntoRawDescriptor) to get full ownership over a descriptor pointing to the same resource.

Trait Implementations

impl TryFrom<&dyn AsRawDescriptor> for SafeDescriptor

fn try_from(rd: &dyn AsRawDescriptor) -> Result<Self, Self::Error>

Clones the underlying descriptor (handle), internally creating a new descriptor.

WARNING: Windows does NOT support cloning/duplicating all types of handles. DO NOT use this function on IO completion ports, sockets, or pseudo-handles (except those from GetCurrentProcess or GetCurrentThread). See https://docs.microsoft.com/en-us/windows/win32/api/handleapi/nf-handleapi-duplicatehandle for further details.

TODO(b/191800567): this API has sharp edges on Windows. We should evaluate making some adjustments to smooth those edges.

type Error = Error

The type returned in the event of a conversion error.

Implementations on Foreign Types

impl AsRawDescriptor for File

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for Stderr

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for Stdin

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for Stdout

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for TcpListener

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for TcpStream

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for UdpSocket

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for OwnedFd

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for UnixDatagram

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for UnixListener

fn as_raw_descriptor(&self) -> RawDescriptor

impl AsRawDescriptor for UnixStream

fn as_raw_descriptor(&self) -> RawDescriptor

impl<T> AsRawDescriptor for Arc<T>

where T: AsRawDescriptor,

fn as_raw_descriptor(&self) -> RawDescriptor

Implementors

impl AsRawDescriptor for &StreamChannel

impl AsRawDescriptor for Event

impl AsRawDescriptor for SharedMemory

USE THIS CAUTIOUSLY. On Windows, the returned handle is not a file handle and cannot be used as if it were one. It is a handle to a the associated file mapping object and should only be used for memory-mapping the file view.

impl AsRawDescriptor for PlatformEvent

impl AsRawDescriptor for NetlinkGenericSocket

impl AsRawDescriptor for SignalFd

impl AsRawDescriptor for TcpSocket

impl AsRawDescriptor for UnixSeqpacket

impl AsRawDescriptor for UnixSeqpacketListener

impl AsRawDescriptor for UnlinkUnixSeqpacketListener

impl AsRawDescriptor for StreamChannel

impl AsRawDescriptor for Tube

impl AsRawDescriptor for FakeTimer

impl AsRawDescriptor for Timer

impl AsRawDescriptor for RecvTube

impl AsRawDescriptor for SendTube

impl AsRawDescriptor for Descriptor

impl AsRawDescriptor for SafeDescriptor

impl<T: EventToken> AsRawDescriptor for EventContext<T>

impl<T: EventToken> AsRawDescriptor for WaitContext<T>

impl<T: AsRawDescriptor> AsRawDescriptor for ScmSocket<T>