on_read Event

Fires when the OS needs to read data from an open file.

Syntax

class FUSEReadEventParams(object):
  @property
  def path() -> str: ...
  @property
  def file_context() -> int: ...
  @property
  def buffer() -> c_void_p: ...
  @property
  def size() -> int: ...
  @property
  def offset() -> int: ...
  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

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

Remarks

This event fires when the OS needs to read data from the already-open file, identified by either Path or FileContext.

To handle this event properly, applications should read Size bytes of data from the specified file into the memory region pointed to by Buffer. Reading must begin at the specified Offset in the file and all of the requested data is expected to be read. Applications must not attempt to copy more than Size bytes of data into Buffer.

Please refer to the Buffer Parameters topic for more information on how to work with memory buffer event parameters.

When reading is complete, applications must set Result to the actual number of bytes written to Buffer. Note: While it is technically possible for an application to return fewer than Size bytes of data, doing so is abnormal, and should be avoided. Most processes treat read requests as "all or nothing", so returning less data than requested is likely to cause an ungraceful failure.

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]