Struct cfile::CFile

pub struct CFile(_);

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

pub fn fdopen<S: AsRef<str>>(fd: RawFd, mode: S) -> Result<CFile>

impl CFile

Important traits for Unlocked

impl Read for Unlockedimpl Write for Unlocked

pub fn unlocked(self) -> Unlocked

Returns a unlocked CFile stream except that they do not use locking.

Methods from Deref<Target = CFileRef>

pub 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.

Important traits for Bytes<'a>

impl<'a> Iterator for Bytes<'a> type Item = Result<u8>;

pub fn bytes(&self) -> Bytes

An iterator over the bytes of a *FILE stream.

Important traits for Lines<T>

impl<T> Iterator for Lines<T> where
    T: Iterator<Item = Result<u8>>,  type Item = Result<String>;

pub fn lines(&self) -> Lines<Bytes>

An iterator over the lines of a *FILE stream.

pub fn lock(&mut self) -> FileLock

acquires an exclusive lock on the specified object.

If another thread has already locked the object, will block until the lock is released.

Examples

use std::io::Write;
use cfile::tmpfile;

let mut f = tmpfile().unwrap();
let mut l = f.lock();

assert_eq!(l.write(b"test").unwrap(), 4);

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

a non-blocking version of lock();

if the lock cannot be acquired immediately, try_lock() returns None instead of blocking.

Examples

use std::io::{Read, Write, BufRead, BufReader, Seek, SeekFrom};
use cfile::tmpfile;

let mut f = tmpfile().unwrap();

if let Some(mut c) = f.try_lock() {
    assert_eq!(c.write(b"test").unwrap(), 4);
}

assert_eq!(f.seek(SeekFrom::Start(0)).unwrap(), 0); // seek to the beginning of stream

let mut r = BufReader::new(f);
let mut s = String::new();
assert_eq!(r.read_line(&mut s).unwrap(), 4); // read back the text
assert_eq!(s, "test");

Trait Implementations

impl Send for CFile

impl Drop for CFile

fn drop(&mut self)

Executes the destructor for this type.

impl AsRef<CFileRef> for CFile

Important traits for CFileRef

impl Read for CFileRefimpl Write for CFileRef

fn as_ref(&self) -> &CFileRef

Performs the conversion.

impl AsMut<CFileRef> for CFile

Important traits for CFileRef

impl Read for CFileRefimpl Write for CFileRef

fn as_mut(&mut self) -> &mut CFileRef

Performs the conversion.

impl Deref for CFile

type Target = CFileRef

The resulting type after dereferencing.

Important traits for CFileRef

impl Read for CFileRefimpl Write for CFileRef

fn deref(&self) -> &CFileRef

Dereferences the value.

impl DerefMut for CFile

Important traits for CFileRef

impl Read for CFileRefimpl Write for CFileRef

fn deref_mut(&mut self) -> &mut CFileRef

Mutably dereferences the value.

impl Borrow<CFileRef> for CFile

Important traits for CFileRef

impl Read for CFileRefimpl Write for CFileRef

fn borrow(&self) -> &CFileRef

Immutably borrows from an owned value.

impl BorrowMut<CFileRef> for CFile

Important traits for CFileRef

impl Read for CFileRefimpl Write for CFileRef

fn borrow_mut(&mut self) -> &mut CFileRef

Mutably borrows from an owned value.

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_vectored(&mut self, bufs: &mut [IoSliceMut]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

unsafe fn initializer(&self) -> Initializer

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

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

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, appending them to 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 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 writer, 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_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

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

Attempts to write an entire buffer into this writer.

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.

fn stream_len(&mut self) -> Result<u64, Error>

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

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

Returns the current seek position from the start of the stream.

impl IntoRawFd for CFile

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.

impl ForeignType for CFile

type CType = FILE

The raw C type.

type Ref = CFileRef

The type representing a reference to this type.

Important traits for CFile

impl Read for CFileimpl Write for CFile

unsafe fn from_ptr(ptr: *mut FILE) -> CFile

Constructs an instance of this type from its raw type.

fn as_ptr(&self) -> *mut FILE

Returns a raw pointer to the wrapped value.

fn into_ptr(self) -> *mut Self::CType

Consumes the wrapper and returns the raw pointer.