Struct base::descriptor::SafeDescriptor

pub struct SafeDescriptor {
    pub(crate) descriptor: RawDescriptor,
}

Wraps a RawDescriptor and safely closes it when self falls out of scope.

Fields

descriptor: RawDescriptor

Implementations

impl SafeDescriptor

pub fn try_clone(&self) -> Result<SafeDescriptor>

Clones this descriptor, internally creating a new descriptor. The new SafeDescriptor will share the same underlying count within the kernel.

Trait Implementations

impl AsRawDescriptor for SafeDescriptor

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl AsRawFd for SafeDescriptor

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for SafeDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SafeDescriptor

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SafeDescriptor

fn drop(&mut self)

Executes the destructor for this type.

impl From<Event> for SafeDescriptor

fn from(evt: Event) -> Self

Converts to this type from the input type.

impl From<File> for SafeDescriptor

fn from(f: File) -> SafeDescriptor

Converts to this type from the input type.

impl From<OwnedFd> for SafeDescriptor

fn from(fd: OwnedFd) -> Self

Converts to this type from the input type.

impl From<PlatformEvent> for SafeDescriptor

fn from(evt: PlatformEvent) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for Event

fn from(sd: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for File

fn from(s: SafeDescriptor) -> File

Converts to this type from the input type.

impl From<SafeDescriptor> for OwnedFd

fn from(s: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for PlatformEvent

fn from(sd: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for TcpListener

fn from(s: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for TcpStream

fn from(s: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for UnixSeqpacket

fn from(s: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<SafeDescriptor> for UnixStream

fn from(s: SafeDescriptor) -> Self

Converts to this type from the input type.

impl From<SharedMemory> for SafeDescriptor

fn from(sm: SharedMemory) -> SafeDescriptor

Converts to this type from the input type.

impl From<UnixSeqpacket> for SafeDescriptor

fn from(s: UnixSeqpacket) -> Self

Converts to this type from the input type.

impl FromRawDescriptor for SafeDescriptor

unsafe fn from_raw_descriptor(descriptor: RawDescriptor) -> Self

Safety

impl IntoRawDescriptor for SafeDescriptor

fn into_raw_descriptor(self) -> RawDescriptor

impl PartialEq for SafeDescriptor

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SafeDescriptor

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

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.

impl TryFrom<&dyn AsRawFd> for SafeDescriptor

type Error = Error

The type returned in the event of a conversion error.

fn try_from(fd: &dyn AsRawFd) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SafeDescriptor