bernardo-tui 0.2.7

A keyboard-only, distraction-free TUI widget library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use std::fmt::Debug;
use std::fs::Metadata;
use std::path::{Path, PathBuf};
use streaming_iterator::StreamingIterator;

use crate::fs::dir_entry::DirEntry;
use crate::fs::fsf_ref::FsfRef;
use crate::fs::read_error::{ListError, ReadError};
use crate::fs::write_error::WriteError;

// all paths except root_path are RELATIVE to root_path.

pub trait FilesystemFront: Debug + Send + Sync {
    // Absolute path to root folder. Just for informative reasons.
    fn root_path(&self) -> &PathBuf;

    fn blocking_read_entire_file(&self, path: &Path) -> Result<Vec<u8>, ReadError>;

    /*
    Blocking.
     */
    fn is_dir(&self, path: &Path) -> bool;

    /*
    Blocking

    TODO:
    - define if that's a file, symlink or any
     */
    fn is_file(&self, path: &Path) -> bool;

    fn hash_seed(&self) -> usize;

    fn blocking_list(&self, path: &Path) -> Result<Vec<DirEntry>, ListError>;

    fn metadata(&self, path: &Path) -> Result<Metadata, ReadError>;

    fn file_size(&self, path: &Path) -> Result<u64, ReadError>;

    fn exists(&self, path: &Path) -> bool;

    fn blocking_overwrite_with_stream(
        &self,
        path: &Path,
        stream: &mut dyn StreamingIterator<Item = [u8]>,
        must_exist: bool,
    ) -> Result<usize, WriteError>;

    fn blocking_overwrite_with_bytes(&self, path: &Path, s: &[u8], must_exist: bool) -> Result<usize, WriteError>;

    fn to_fsf(self) -> FsfRef;
}