Struct termscp::host::Localhost

pub struct Localhost { /* fields omitted */ }

Localhost

Localhost is the entity which holds the information about the current directory and host. It provides functions to navigate across the local host file system

Implementations

impl Localhost

pub fn new(wrkdir: PathBuf) -> Result<Localhost, HostError>

new

Instantiates a new Localhost struct

pub fn pwd(&self) -> PathBuf

pwd

Print working directory

pub fn list_dir(&self) -> Vec<FsEntry>

list_dir

List files in current directory

pub fn change_wrkdir(&mut self, new_dir: &Path) -> Result<PathBuf, HostError>

change_wrkdir

Change working directory with the new provided directory

pub fn mkdir(&mut self, dir_name: &Path) -> Result<(), HostError>

mkdir

Make a directory at path and update the file list (only if relative)

pub fn mkdir_ex(
    &mut self,
    dir_name: &Path,
    ignex: bool
) -> Result<(), HostError>

mkdir_ex

Extended option version of makedir. ignex: don't report error if directory already exists

pub fn remove(&mut self, entry: &FsEntry) -> Result<(), HostError>

remove

Remove file entry

pub fn rename(
    &mut self,
    entry: &FsEntry,
    dst_path: &Path
) -> Result<(), HostError>

rename

Rename file or directory to new name

pub fn copy(&mut self, entry: &FsEntry, dst: &Path) -> Result<(), HostError>

copy

Copy file to destination path

pub fn stat(&self, path: &Path) -> Result<FsEntry, HostError>

stat

Stat file and create a FsEntry

pub fn chmod(&self, path: &Path, pex: (u8, u8, u8)) -> Result<(), HostError>

chmod

Change file mode to file, according to UNIX permissions

pub fn open_file_read(&self, file: &Path) -> Result<File, HostError>

open_file_read

Open file for read

pub fn open_file_write(&self, file: &Path) -> Result<File, HostError>

open_file_write

Open file for write

pub fn file_exists(&self, path: &Path) -> bool

file_exists

Returns whether provided file path exists

pub fn scan_dir(&self, dir: &Path) -> Result<Vec<FsEntry>, HostError>

scan_dir

Get content of the current directory as a list of fs entry (Windows)