Struct finch::platform::linux::FileSystem

pub struct FileSystem { /* fields omitted */ }

A basic model of the Linux Filesystem

Methods

impl FileSystem

pub fn new(base_path: Option<PathBuf>) -> Result<FileSystem>

Create a new model of the Linux Filesystem.

The filedescriptors 0, 1, and 2 are initialized to files named: /stdin, /stdout, and /stderr respectively.

If given an optional path, then this path will be used to look for files when opening files.

pub fn fd_mut(&mut self, fd: usize) -> Option<&mut FileDescriptor>

Get a mutable reference to a FileDescriptor if it exists.

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

Seek a file descriptor, according to the whence and offset.

pub fn fd_valid(&self, fd: usize) -> bool

Returns true if the file descriptor exists.

pub fn open(&mut self, path: &str) -> Result<Option<usize>>

Attempt to open a file and read it into the filesystem model. Returns a file descriptor if the file exists, or None.

pub fn create(&mut self, path: &str) -> Result<usize>

Open a file, or create it if it does not exist. Returns file descriptor.

pub fn exists(&self, path: &str) -> bool

Return true if a file exists, false otherwise

pub fn zeroize(&mut self, path: &str)

Zeroize the data in a file

pub fn file_bytes(&self, path: &str) -> Option<&[Expression]>

Get data from a file

pub fn file_bytes_mut(&mut self, path: &str) -> Option<&mut Vec<Expression>>

Get a mutable reference to the data for a file

pub fn fd_bytes(&self, fd: usize) -> Option<&[Expression]>

Get the bytes to a file pointed to by a file descriptor

pub fn close_fd(&mut self, fd: usize) -> bool

Close a file descriptor. Returns true if file descriptor existed, false otherwise

pub fn read_fd(
    &mut self,
    fd: usize,
    length: usize
) -> Result<Option<Vec<Expression>>>

Read from a file descriptor

pub fn write_fd(&mut self, fd: usize, data: Vec<Expression>) -> Result<()>

Write to a file descriptor

pub fn size_fd(&self, fd: usize) -> Option<usize>

Get size of file pointed to by file descriptor

pub fn write(
    &mut self,
    path: &str,
    write_data: Vec<Expression>,
    offset: usize
) -> Result<()>

Write data into a file at an offset

Trait Implementations

impl Clone for FileSystem

fn clone(&self) -> FileSystem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileSystem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FileSystem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for FileSystem

impl PartialEq<FileSystem> for FileSystem

fn eq(&self, other: &FileSystem) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &FileSystem) -> bool

This method tests for !=.

impl Serialize for FileSystem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for FileSystem

impl StructuralPartialEq for FileSystem