Struct yash_env::system::virtual::OpenFileDescription

pub struct OpenFileDescription {
    pub file: Rc<RefCell<INode>>,
    pub offset: usize,
    pub is_readable: bool,
    pub is_writable: bool,
    pub is_appending: bool,
}

State of a file opened for reading and/or writing.

Fields

file: Rc<RefCell<INode>>

The file.

offset: usize

Position in bytes to perform next I/O operation at.

is_readable: bool

Whether this file is opened for reading.

is_writable: bool

Whether this file is opened for writing.

is_appending: bool

Whether this file is opened for appending.

Implementations

impl OpenFileDescription

pub fn is_readable(&self) -> bool

Returns true if you can read from this open file description.

pub fn is_writable(&self) -> bool

Returns true if you can write to this open file description.

pub fn is_ready_for_reading(&self) -> bool

Returns true if you can read from this open file description without blocking.

pub fn is_ready_for_writing(&self) -> bool

Returns true if you can write to this open file description without blocking.

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

Reads from this open file description.

Returns the number of bytes successfully read.

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

Writes to this open file description.

Returns the number of bytes successfully written.

pub fn seek(&mut self, offset: isize, whence: Whence) -> Result<usize, Errno>

Moves the file offset and returns the new offset.

The current implementation for OpenFileDescription does not support Whence::SeekHole or Whence::SeekData.

pub fn i_node(&self) -> Rc<RefCell<INode>>

Returns the i-node this open file description is operating on.

Trait Implementations

impl Clone for OpenFileDescription

fn clone(&self) -> OpenFileDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenFileDescription

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

Formats the value using the given formatter.

impl Drop for OpenFileDescription

fn drop(&mut self)

Executes the destructor for this type.