Struct Descriptor

pub struct Descriptor { /* private fields */ }

A file descriptor that reference an open file. Also contains flags that change the behaviour of this file descriptor.

Implementations

impl Descriptor

pub fn new(file: CompatFile) -> Self

pub fn file(&self) -> &CompatFile

pub fn flags(&self) -> DescriptorFlags

pub fn set_flags(&mut self, flags: DescriptorFlags)

pub fn into_file(self) -> CompatFile

pub fn close( self, host: &Host, cb_queue: &mut CallbackQueue, ) -> Option<Result<(), SyscallError>>

Close the descriptor. The host option is a legacy option for legacy file.

pub fn dup(&self, flags: DescriptorFlags) -> Self

Duplicate the descriptor, with both descriptors pointing to the same OpenFile. In Linux, the descriptor flags aren’t typically copied to the new descriptor, so we explicitly require a flags value to avoid confusion.

pub fn into_raw(descriptor: Box<Self>) -> *mut Self

pub fn from_raw(descriptor: *mut Self) -> Option<Box<Self>>

pub unsafe fn from_legacy_file( legacy_file: *mut LegacyFile, descriptor_flags: OFlag, ) -> Descriptor

The new descriptor takes ownership of the reference to the legacy file and does not increment its ref count, but will decrement the ref count when this descriptor is freed/dropped with descriptor_free(). The descriptor flags must be either 0 or O_CLOEXEC.

If creating a descriptor for a TCP object, you should use descriptor_fromLegacyTcp instead. If legacy_file is a TCP socket, this function will panic.

Safety

Takes ownership of legacy_file, which must be safely dereferenceable.

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.

impl IsSend for Descriptor

impl IsSync for Descriptor