Update for review

Author: diqiu50

clients/filesystem-fuse/src/filesystem.rs

@@ -32,33 +32,33 @@ pub(crate) type Result<T> = std::result::Result<T, Errno>;
 #[async_trait]
 pub(crate) trait RawFileSystem: Send + Sync {
     /// Init the file system
-    async fn init(&self);
+    async fn init(&self) -> Result<()>;
 
-    /// Get the file path by file id
+    /// Get the file path by file id, if the file id is valid, return the file path
     async fn get_file_path(&self, file_id: u64) -> String;
 
-    /// Validate the file id and file handle, if the file id or file handle is invalid, return error
+    /// Validate the file id and file handle, if the file id and file handle is valid, return success
     async fn valid_file_id(&self, file_id: u64, fh: u64) -> Result<()>;
 
-    /// Get the file stat by file id
+    /// Get the file stat by file id. if the file id is valid, return the file stat
     async fn stat(&self, file_id: u64) -> Result<FileStat>;
 
-    /// Get the file stat by parent file id and file name
+    /// Lookup the file by parent file id and file name, if the file is exist, return the file stat
     async fn lookup(&self, parent_file_id: u64, name: &str) -> Result<FileStat>;
 
-    /// Read the directory by file id
+    /// Read the directory by file id, if the file id is a valid directory, return the file stat list
     async fn read_dir(&self, dir_file_id: u64) -> Result<Vec<FileStat>>;
 
-    /// Open the file by file id and flags
+    /// Open the file by file id and flags, if the file id is a valid file, return the file handle
     async fn open_file(&self, file_id: u64, flags: u32) -> Result<FileHandle>;
 
-    /// Open the directory by file id and flags
+    /// Open the directory by file id and flags, if successful, return the file handle
     async fn open_dir(&self, file_id: u64, flags: u32) -> Result<FileHandle>;
 
-    /// Create the file by parent file id and file name and flags
+    /// Create the file by parent file id and file name and flags, if successful, return the file handle
     async fn create_file(&self, parent_file_id: u64, name: &str, flags: u32) -> Result<FileHandle>;
 
-    /// Create the directory by parent file id and file name
+    /// Create the directory by parent file id and file name, if successful, return the file id
     async fn create_dir(&self, parent_file_id: u64, name: &str) -> Result<u64>;
 
     /// Set the file attribute by file id and file stat
@@ -70,13 +70,13 @@ pub(crate) trait RawFileSystem: Send + Sync {
     /// Remove the directory by parent file id and file name
     async fn remove_dir(&self, parent_file_id: u64, name: &str) -> Result<()>;
 
-    /// Close the file by file id and file handle
+    /// Close the file by file id and file handle, if successful
     async fn close_file(&self, file_id: u64, fh: u64) -> Result<()>;
 
-    /// Read the file content by file id, file handle, offset and size
+    /// Read the file content by file id, file handle, offset and size, if successful, return read result
     async fn read(&self, file_id: u64, fh: u64, offset: u64, size: u32) -> Result<Bytes>;
 
-    /// Write the file content by file id, file handle, offset and data
+    /// Write the file content by file id, file handle, offset and data, if successful, return write size
     async fn write(&self, file_id: u64, fh: u64, offset: u64, data: &[u8]) -> Result<u32>;
 }
 
@@ -85,32 +85,32 @@ pub(crate) trait RawFileSystem: Send + Sync {
 #[async_trait]
 pub(crate) trait PathFileSystem: Send + Sync {
     /// Init the file system
-    async fn init(&self);
+    async fn init(&self) -> Result<()>;
 
-    /// Get the file stat by file path
+    /// Get the file stat by file path, if the file is exist, return the file stat
     async fn stat(&self, name: &str) -> Result<FileStat>;
 
-    /// Get the file stat by parent file path and file name
+    /// Get the file stat by parent file path and file name, if the file is exist, return the file stat
     async fn lookup(&self, parent: &str, name: &str) -> Result<FileStat>;
 
-    /// Read the directory by file path
+    /// Read the directory by file path, if the file is a valid directory, return the file stat list
     async fn read_dir(&self, name: &str) -> Result<Vec<FileStat>>;
 
-    /// Open the file by file path and flags
+    /// Open the file by file path and flags, if the file is exist, return the opened file
     async fn open_file(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>;
 
-    /// Open the directory by file path and flags
+    /// Open the directory by file path and flags, if the file is exist, return the opened file
     async fn open_dir(&self, name: &str, flags: OpenFileFlags) -> Result<OpenedFile>;
 
-    /// Create the file by parent file path and file name and flags
+    /// Create the file by parent file path and file name and flags, if successful, return the opened file
     async fn create_file(
         &self,
         parent: &str,
         name: &str,
         flags: OpenFileFlags,
     ) -> Result<OpenedFile>;
 
-    /// Create the directory by parent file path and file name
+    /// Create the directory by parent file path and file name, if successful, return the file stat
     async fn create_dir(&self, parent: &str, name: &str) -> Result<FileStat>;
 
     /// Set the file attribute by file path and file stat
@@ -123,6 +123,7 @@ pub(crate) trait PathFileSystem: Send + Sync {
     async fn remove_dir(&self, parent: &str, name: &str) -> Result<()>;
 }
 
+// FileSystemContext is the system environment for the fuse file system.
 pub(crate) struct FileSystemContext {
     // system user id
     pub(crate) uid: u32,
@@ -140,7 +141,6 @@ pub(crate) struct FileSystemContext {
     pub(crate) block_size: u32,
 }
 
-// FileSystemContext is the file system context for the file system implementation.
 impl FileSystemContext {
     pub(crate) fn new(uid: u32, gid: u32) -> Self {
         FileSystemContext {
@@ -153,7 +153,7 @@ impl FileSystemContext {
     }
 }
 
-// FileStat is the file stat for the file system.
+// FileStat is the file metadata of the file
 #[derive(Clone, Debug)]
 pub struct FileStat {
     // file id for the file system.
@@ -214,8 +214,10 @@ pub struct OpenFileFlags(u32);
 /// File reader interface  for read file content
 #[async_trait]
 pub(crate) trait FileReader: Sync + Send {
+    /// read the file content by offset and size, if successful, return the read result
     async fn read(&mut self, offset: u64, size: u32) -> Result<Bytes>;
 
+    /// close the file
     async fn close(&mut self) -> Result<()> {
         Ok(())
     }
@@ -224,12 +226,15 @@ pub(crate) trait FileReader: Sync + Send {
 /// File writer interface  for write file content
 #[async_trait]
 pub trait FileWriter: Sync + Send {
+    /// write the file content by offset and data, if successful, return the write size
     async fn write(&mut self, offset: u64, data: &[u8]) -> Result<u32>;
 
+    /// close the file
     async fn close(&mut self) -> Result<()> {
         Ok(())
     }
 
+    /// flush the file
     async fn flush(&mut self) -> Result<()> {
         Ok(())
     }

clients/filesystem-fuse/src/fuse_api_handle.rs

@@ -115,7 +115,7 @@ impl<T: RawFileSystem> Filesystem for FuseApiHandle<T> {
         fh: Option<u64>,
         _flags: u32,
     ) -> fuse3::Result<ReplyAttr> {
-        // check the opened file file_id is the same as the inode
+        // check the fh is associated with the file_id
         if let Some(fh) = fh {
             self.fs.valid_file_id(inode, fh).await?;
         }
@@ -134,7 +134,7 @@ impl<T: RawFileSystem> Filesystem for FuseApiHandle<T> {
         fh: Option<u64>,
         set_attr: SetAttr,
     ) -> fuse3::Result<ReplyAttr> {
-        // check the opened file file_id is the same as the inode
+        // check the fh is associated with the file_id
         if let Some(fh) = fh {
             self.fs.valid_file_id(inode, fh).await?;
         }