Struct libnotcurses_sys::NcFile

pub struct NcFile { /* fields omitted */ }

A wrapper struct around libc::FILE

The notcurses FILE type FILE_NC a struct imported through bindgen, while the equivalent libc crate FILE (FILE_LIBC) is an opaque enum.

Several methods are provided to cast back and forth between both types, in order to allow both rust libc operations and notcurses file operations over the same underlying *FILE.

Implementations

impl NcFile

pub fn from_nc(file: *mut FILE_NC) -> Self

NcFile constructor from a file produced by notcurses

pub unsafe fn from_libc(file: *mut FILE_LIBC) -> Self

NcFile constructor from a file produced by the libc crate

pub fn as_libc_ptr(&self) -> *mut FILE_LIBC

Returns the file pointer in the format expected by the [libc] crate

pub fn as_nc_ptr(&self) -> *mut FILE_NC

Returns the file pointer in the format expected by notcurses

pub fn current_pos(&self) -> Result<u64, Error>

Returns the current position in the file.

On error Error::Errno(errno) is returned.

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

Reads the file from start to end. Convenience method

Trait Implementations

impl Debug for NcFile

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

Formats the value using the given formatter.

impl Drop for NcFile

fn drop(&mut self)

Ensures the file stream is closed before abandoning the data.

impl Read for NcFile

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

Reads exactly the number of bytes required to fill buf.

If the end of the file is reached before buf is filled, Err(EndOfFile(bytes_read)) will be returned. The data that was read before that will still have been placed into buf.

Upon some other error, Err(Errno(errno)) will be returned.

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

Reads the entire file starting from the current_position expanding buf as needed.

On a successful read, this function will return Ok(bytes_read).

If an error occurs during reading, some varient of error will be returned.

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

Reads the entire file from the beginning and stores it in a string

On a successful read, this function will return Ok(bytes_read).

If an error occurs during reading, some varient of error will be returned.

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

Reads exactly the number of bytes required to fill buf.

If the end of the file is reached before buf is filled, Err(EndOfFile(bytes_read)) will be returned. The data that was read before that will still have been placed into buf.

Upon some other error, Err(Errno(errno)) will be returned.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

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

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

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 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 Seek for NcFile

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

Changes the current position in the file using the SeekFrom enum.

To set relative to the beginning of the file (i.e. index is 0 + offset):

SeekFrom::Start(offset)

To set relative to the end of the file (i.e. index is file_lenth - 1 - offset):

SeekFrom::End(offset)

To set relative to the current position:

SeekFrom::End(offset)

On error Error::Errno(errno) is returned.

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

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

Rewind to the beginning of a stream.

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

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

Returns the length of this stream (in bytes).

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

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