Struct Drive

pub struct Drive {
    pub lb: Lb,
    pub root: Uuid,
    pub data: Arc<Mutex<HashMap<fileid3, FileEntry>>>,
}

Fields

lb: Lb

root: Uuid

must be not-nil before NFSFIlesSystem is mounted

data: Arc<Mutex<HashMap<fileid3, FileEntry>>>

probably this doesn’t need to have a global lock, but interactions here are generally speedy, and for now we’ll go for robustness over performance. Hopefully this accomplishes that and not deadlock. TBD.

this is stored in memory as it’s own entity and not stored in core for two reasons:

1. size computations are expensive in core
2. nfs needs to update timestamps to specified values
3. nfs models properties we don’t, like file permission bits

Implementations

impl Drive

pub async fn prepare_caches(&self)

pub async fn sync(&self)

impl Drive

pub async fn init() -> Self

pub async fn import() -> CliResult<()>

pub async fn mount() -> CliResult<()>

pub fn progress() -> Option<Box<dyn Fn(SyncProgress) + Send>>

Trait Implementations

impl Clone for Drive

fn clone(&self) -> Drive

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl NFSFileSystem for Drive

fn readdir<'life0, 'async_trait>( &'life0 self, dirid: fileid3, start_after: fileid3, max_entries: usize, ) -> Pin<Box<dyn Future<Output = Result<ReadDirResult, nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

they will provide a start_after of 0 for no id

fn remove<'life0, 'life1, 'async_trait>( &'life0 self, dirid: fileid3, filename: &'life1 filename3, ) -> Pin<Box<dyn Future<Output = Result<(), nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Removes a file. If not supported dur to readonly file system this should return Err(nfsstat3::NFS3ERR_ROFS)

fn rename<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, from_dirid: fileid3, from_filename: &'life1 filename3, to_dirid: fileid3, to_filename: &'life2 filename3, ) -> Pin<Box<dyn Future<Output = Result<(), nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

either an overwrite rename or move

fn root_dir(&self) -> fileid3

Returns the ID the of the root directory “/”

fn capabilities(&self) -> VFSCapabilities

Returns the set of capabilities supported

fn write<'life0, 'life1, 'async_trait>( &'life0 self, id: fileid3, offset: u64, buffer: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<fattr3, nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes the contents of a file returning (bytes, EOF) Note that offset/count may go past the end of the file and that in that case, the file is extended. If not supported due to readonly file system this should return Err(nfsstat3::NFS3ERR_ROFS)

fn create<'life0, 'life1, 'async_trait>( &'life0 self, dirid: fileid3, filename: &'life1 filename3, attr: sattr3, ) -> Pin<Box<dyn Future<Output = Result<(fileid3, fattr3), nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates a file with the following attributes. If not supported due to readonly file system this should return Err(nfsstat3::NFS3ERR_ROFS)

fn create_exclusive<'life0, 'life1, 'async_trait>( &'life0 self, dirid: fileid3, filename: &'life1 filename3, ) -> Pin<Box<dyn Future<Output = Result<fileid3, nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Creates a file if it does not already exist this should return Err(nfsstat3::NFS3ERR_ROFS)

fn lookup<'life0, 'life1, 'async_trait>( &'life0 self, dirid: fileid3, filename: &'life1 filename3, ) -> Pin<Box<dyn Future<Output = Result<fileid3, nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Look up the id of a path in a directory

fn getattr<'life0, 'async_trait>( &'life0 self, id: fileid3, ) -> Pin<Box<dyn Future<Output = Result<fattr3, nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Returns the attributes of an id. This method should be fast as it is used very frequently.

fn setattr<'life0, 'async_trait>( &'life0 self, id: fileid3, setattr: sattr3, ) -> Pin<Box<dyn Future<Output = Result<fattr3, nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sets the attributes of an id this should return Err(nfsstat3::NFS3ERR_ROFS) if readonly

fn read<'life0, 'async_trait>( &'life0 self, id: fileid3, offset: u64, count: u32, ) -> Pin<Box<dyn Future<Output = Result<(Vec<u8>, bool), nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reads the contents of a file returning (bytes, EOF) Note that offset/count may go past the end of the file and that in that case, all bytes till the end of file are returned. EOF must be flagged if the end of the file is reached by the read.

fn mkdir<'life0, 'life1, 'async_trait>( &'life0 self, dirid: fileid3, dirname: &'life1 filename3, ) -> Pin<Box<dyn Future<Output = Result<(fileid3, fattr3), nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Makes a directory with the following attributes. If not supported dur to readonly file system this should return Err(nfsstat3::NFS3ERR_ROFS)

fn symlink<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _dirid: fileid3, _linkname: &'life1 filename3, _symlink: &'life2 nfspath3, _attr: &'life3 sattr3, ) -> Pin<Box<dyn Future<Output = Result<(fileid3, fattr3), nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Makes a symlink with the following attributes. If not supported due to readonly file system this should return Err(nfsstat3::NFS3ERR_ROFS)

fn readlink<'life0, 'async_trait>( &'life0 self, _id: fileid3, ) -> Pin<Box<dyn Future<Output = Result<nfspath3, nfsstat3>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reads a symlink

fn readdir_simple<'life0, 'async_trait>( &'life0 self, dirid: u64, count: usize, ) -> Pin<Box<dyn Future<Output = Result<ReadDirSimpleResult, nfsstat3>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Simple version of readdir. Only need to return filename and id

fn fsinfo<'life0, 'async_trait>( &'life0 self, root_fileid: u64, ) -> Pin<Box<dyn Future<Output = Result<fsinfo3, nfsstat3>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Get static file system Information

fn id_to_fh(&self, id: u64) -> nfs_fh3

Converts the fileid to an opaque NFS file handle. Optional.

fn fh_to_id(&self, id: &nfs_fh3) -> Result<u64, nfsstat3>

Converts an opaque NFS file handle to a fileid. Optional.

fn path_to_id<'life0, 'life1, 'async_trait>( &'life0 self, path: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<u64, nfsstat3>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Converts a complete path to a fileid. Optional. The default implementation walks the directory structure with lookup()

fn serverid(&self) -> [u8; 8]