on_read_dir Event

Fires when the OS wants to read (enumerate) a directory's contents.


class FUSEReadDirEventParams(object):
  def path() -> str: ...
  def filler_context() -> int: ...
  def result() -> int: ...
  def result(value) -> None: ...

# In class FUSE:
def on_read_dir() -> Callable[[FUSEReadDirEventParams], None]: ...
def on_read_dir(event_hook: Callable[[FUSEReadDirEventParams], None]) -> None: ...


This event fires when the OS wants to enumerate the contents of the directory, identified by Path. In response to this event the application must call the filler method and pass it FillerContextparameter as well as the information about the directory entry. Please, refer to the description of filler for further details.

If filler returns an error code, set Result to the returned code (do not negate the code). If there are no more files to pass, set Result to 0.

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.

Copyright (c) 2021 Callback Technologies, Inc. - All rights reserved.
CBFS FUSE 2020 Python Edition - Version 20.0 [Build 7836]