Struct File 

pub struct File {
    pub fd: c_int,
    pub reference: bool,
}

Fields

fd: c_int

reference: bool

To avoid self referential FILE struct that needs both a reader and a writer, make “reference” files that share fd but don’t close on drop.

Implementations

impl File

pub fn new(fd: c_int) -> Self

pub fn open(path: CStr<'_>, oflag: c_int) -> Result<Self, Errno>

pub fn openat(dirfd: c_int, path: CStr<'_>, oflag: c_int) -> Result<Self, Errno>

pub fn create(path: CStr<'_>, oflag: c_int, mode: mode_t) -> Result<Self, Errno>

pub fn createat( dirfd: c_int, path: CStr<'_>, oflag: c_int, mode: mode_t, ) -> Result<Self, Errno>

pub fn sync_all(&self) -> Result<(), Errno>

pub fn set_len(&self, size: u64) -> Result<(), Errno>

pub fn fstat(&self) -> Result<stat, Errno>

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

pub unsafe fn get_ref(&self) -> Self

Create a new file pointing to the same underlying descriptor. This file will know it’s a “reference” and won’t close the fd. It will, however, not prevent the original file from closing the fd.

Trait Implementations

impl Deref for File

type Target = i32

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for File

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Read for &File

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_out(&mut self, out: Out<'_, [u8]>) -> Result<usize>

unsafe fn initializer(&self) -> Initializer

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R: Read>(self, next: R) -> Chain<Self, R>

where Self: Sized,

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adaptor which will read at most limit bytes from it.

impl Read for File

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_out(&mut self, out: Out<'_, [u8]>) -> Result<usize>

unsafe fn initializer(&self) -> Initializer

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R: Read>(self, next: R) -> Chain<Self, R>

where Self: Sized,

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adaptor which will read at most limit bytes from it.

impl Seek for &File

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

impl Seek for File

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

impl Write for &File

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Write.

impl Write for File

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this object, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments<'_>) -> Result<()>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Write.