on_copy_file_range Event

Fires when the OS needs to copy a range of data from one file to another.

Syntax

class FUSECopyFileRangeEventParams(object):
  @property
  def path_in() -> str: ...
  @property
  def file_context_in() -> int: ...
  @property
  def offset_in() -> int: ...
  @property
  def path_out() -> str: ...
  @property
  def file_context_out() -> int: ...
  @property
  def offset_out() -> int: ...
  @property
  def size() -> int: ...
  @property
  def flags() -> int: ...
  @property
  def result() -> int: ...
  @result.setter
  def result(value) -> None: ...

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

Remarks

Windows:

This event is currently not used.

Linux:

This event fires when the OS needs to copy a range of data from one file to another. The source file is identified either by PathIn or FileContextIn. The destination file is identified either by PathOut or FileContextOut.

OffsetIn specifies the starting offset in the source file from which the data is taken.

OffsetOut specifies the starting offset in the destination file, to which the data should be written.

Size specifies the size of the data block to be copied.

Flags is provided for future extensions and is currently not used.

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.