Struct cfile::CFile

pub struct CFile { /* fields omitted */ }

A reference to an open stream on the filesystem.

An instance of a CFile can be read and/or written depending on what modes it was opened with. CFile also implement Seek to alter the logical cursor that the file contains internally.

Methods

impl CFile

fn from_raw(f: *mut FILE, owned: bool) -> Result<CFile>

Constructs a CFile from a raw pointer.

fn reopen(&self, filename: &str, mode: &str) -> Result<CFile>

opens the file whose name is the string pointed to by filename and associates the stream pointed to by stream with it.

The original stream (if it exists) is closed. The mode argument is used just as in the open() function.

Methods from Deref<Target = RawFile>

fn stream(&self) -> RawFilePtr

returns the raw pointer of the stream

Trait Implementations

impl Sync for CFile

impl Send for CFile

impl Deref for CFile

type Target = RawFile

The resulting type after dereferencing

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

The method called to dereference a value

impl DerefMut for CFile

fn deref_mut(&mut self) -> &mut Self::Target

The method called to mutably dereference a value

impl Stream for CFile

fn position(&self) -> Result<u64>

returns the current position of the stream.

fn eof(&self) -> bool

tests the end-of-file indicator for the stream

fn errno(&self) -> i32

tests the error indicator for the stream

fn last_error(&self) -> Option<Error>

get the last error of the stream

fn clear_error(&self)

clears the end-of-file and error indicators for the stream

fn file_name(&self) -> Result<PathBuf>

returns the file name of the stream

fn metadata(&self) -> Result<Metadata>

Queries metadata about the underlying file.

impl AsRawFd for CFile

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl IntoRawFd for CFile

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl Read for CFile

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_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chars(self) -> Chars<Self>

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

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars.

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

Creates an adaptor which will chain this stream with another.

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

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

impl Write for CFile

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<(), Error>

Attempts to write an entire buffer into this write.

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

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

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

Creates a "by reference" adaptor for this instance of Write.

impl Seek for CFile

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

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

impl Debug for CFile

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

Formats the value using the given formatter.

impl<'a> FileLockExt for CFile

fn lock(&mut self) -> FileLock

acquires an exclusive lock on the specified object.

fn try_lock(&mut self) -> Option<FileLock>

a non-blocking version of lock();

fn unlock(&self)

releases the lock on an object acquired by an earlier call to lock() or try_lock().