Struct HandleRef 

pub struct HandleRef<'fd> { /* private fields */ }

Borrowed version of Handle.

Unlike Handle, when HandleRef is dropped the underlying file descriptor is not closed. This is mainly useful for programs and libraries that have to do operations on &Files and BorrowedFds passed from elsewhere.

Implementations

impl HandleRef<'_>

pub fn from_fd(inner: BorrowedFd<'_>) -> HandleRef<'_>

Wrap a BorrowedFd into a HandleRef.

pub fn try_clone(&self) -> Result<Handle, Error>

Create a copy of a HandleRef.

Note that (unlike BorrowedFd::clone) this method creates a full copy of the underlying file descriptor and thus is more equivalent to BorrowedFd::try_clone_to_owned.

To create a shallow copy of a HandleRef, you can use Clone::clone (or just Copy).

pub fn reopen(&self, flags: impl Into<OpenFlags>) -> Result<File, Error>

“Upgrade” the handle to a usable File handle.

This new File handle is suitable for reading and writing. This does not consume the original handle (allowing for it to be used many times).

The File handle will be opened with O_NOCTTY and O_CLOEXEC set, regardless of whether those flags are present in the flags argument. You can correct these yourself if these defaults are not ideal for you:

1. fcntl(fd, F_SETFD, 0) will let you unset O_CLOEXEC.
2. ioctl(fd, TIOCSCTTY, 0) will set the fd as the controlling terminal (if you don’t have one already, and the fd references a TTY).

Trait Implementations

impl AsFd for HandleRef<'_>

fn as_fd(&self) -> BorrowedFd<'_>

Access the underlying file descriptor for a HandleRef.

Note: This method is primarily intended to allow for tests and other code to check the status of the underlying file descriptor. It is not safe to use this BorrowedFd directly to do filesystem operations. Please use the provided HandleRef methods.

impl<'fd> Clone for HandleRef<'fd>

fn clone(&self) -> HandleRef<'fd>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'fd> Debug for HandleRef<'fd>

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

Formats the value using the given formatter.

impl<'fd> From<BorrowedFd<'fd>> for HandleRef<'fd>

fn from(fd: BorrowedFd<'fd>) -> Self

Shorthand for HandleRef::from_fd.

impl<'fd> Copy for HandleRef<'fd>