on_stat_fs Event

Fires when the OS needs information about the virtual drive's capacity and free space.

Syntax

class FUSEStatFSEventParams(object):
  @property
  def path() -> str: ...
  @property
  def block_size() -> int: ...
  @block_size.setter
  def block_size(value) -> None: ...
  @property
  def total_blocks() -> int: ...
  @total_blocks.setter
  def total_blocks(value) -> None: ...
  @property
  def free_blocks() -> int: ...
  @free_blocks.setter
  def free_blocks(value) -> None: ...
  @property
  def free_blocks_avail() -> int: ...
  @free_blocks_avail.setter
  def free_blocks_avail(value) -> None: ...
  @property
  def total_files() -> int: ...
  @total_files.setter
  def total_files(value) -> None: ...
  @property
  def free_files() -> int: ...
  @free_files.setter
  def free_files(value) -> None: ...
  @property
  def max_filename_length() -> int: ...
  @max_filename_length.setter
  def max_filename_length(value) -> None: ...
  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

# In class FUSE:
@property
def on_stat_fs() -> Callable[[FUSEStatFSEventParams], None]: ...
@on_stat_fs.setter
def on_stat_fs(event_hook: Callable[[FUSEStatFSEventParams], None]) -> None: ...

Remarks

This event fires anytime the OS needs to retrieve the virtual drive's total storage capacity and free space. This event is mandatory to handle, since without it, the OS won't be able to initialize the drive.

To handle this event properly, applications must set event parameters accordingly. BlockSize must be set to the size of the block. TotalBlocks must be set to the total number of blocks on the virtual drive, while FreeBlocks and FreeBlocksAvail denote the number of free blocks available to the system and to the unprivileged user respectively.

Windows:

The minimum drive size accepted by Windows is 6144 bytes. However, the class adjusts the minimum size to be at least 49152 bytes to ensure compatibility with possible changes in future Windows updates.

Linux:

TotalFiles and FreeFiles must be set to the total and available number of file slots (inodes) available within a filesystem. MaxFilenameLength should be set to the maximal length of the filename (path component) supported by the filesystem.

The ResultCode parameter will always be 0 when the event is fired. If the event cannot be handled in a "successful" manner for some reason (e.g., a resource isn't available, security checks failed, etc.), set it to a negative error code value (e.g. -ENOENT to indicate that the file does not exist) to report an appropriate error. Please refer to the Error Reporting and Handling topic for more information.