Struct filedesc::FileDesc

pub struct FileDesc { /* fields omitted */ }

Thin wrapper around an open file descriptor.

The wrapped file descriptor will be closed when the wrapper is dropped.

Implementations

impl FileDesc

pub fn new<T: IntoRawFd>(fd: T) -> Self

Create FileDesc from an object that owns a file descriptor.

This does not do anything to the file descriptor other than wrapping it. Notably, it does not set the close-on-exec flag.

pub unsafe fn from_raw_fd(fd: RawFd) -> Self

Wrap a raw file descriptor in a FileDesc.

This does not do anything to the file descriptor other than wrapping it. Notably, it does not set the close-on-exec flag.

Safety

The input must be a valid file descriptor. The file descriptor must not be closed other than by the created FileDesc, unless ownership of the file descriptor is relinquished by calling into_raw_fd().

pub fn duplicate_from<T: AsRawFd>(other: &T) -> Result<Self>

Duplicate a file descriptor from an object that has a file descriptor.

The new file descriptor will have the close-on-exec flag set. If the platform supports it, the flag will be set atomically.

pub unsafe fn duplicate_raw_fd(fd: RawFd) -> Result<Self>

Duplicate a raw file descriptor and wrap it in a FileDesc.

The new file descriptor will have the close-on-exec flag set. If the platform supports it, the flag will be set atomically.

Safety

The input must be a valid file descriptor. The file descriptor must not be closed other than by the created FileDesc, unless ownership of the file descriptor is relinquished by calling into_raw_fd().

pub fn as_raw_fd(&self) -> RawFd

Get the raw file descriptor.

This function does not release ownership of the underlying file descriptor. The file descriptor will still be closed when the FileDesc is dropped.

pub fn into_raw_fd(self) -> RawFd

Release and get the raw file descriptor.

This function releases ownership of the underlying file descriptor. The file descriptor will not be closed.

pub fn duplicate(&self) -> Result<Self>

Try to duplicate the file descriptor.

The new file descriptor will have the close-on-exec flag set. If the platform supports it, the flag will be set atomically.

pub fn set_close_on_exec(&self, close_on_exec: bool) -> Result<()>

Change the close-on-exec flag of the file descriptor.

Note that you should always try to create file descriptors with the close-on-exec flag already set atomically. Setting the flag later on introduces a race condition if another thread forks before the call to set_close_on_exec finishes.

pub fn get_close_on_exec(&self) -> Result<bool>

Check the close-on-exec flag of the file descriptor.

Trait Implementations

impl AsRawFd for FileDesc

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl<'_> AsRawFd for &'_ FileDesc

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for FileDesc

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

Formats the value using the given formatter.

impl Drop for FileDesc

fn drop(&mut self)

Executes the destructor for this type.

impl FromRawFd for FileDesc

unsafe fn from_raw_fd(fd: RawFd) -> Self

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

impl IntoRawFd for FileDesc

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.