Interface FileReadMoreCallback

All Superinterfaces:
FunctionPointer
Functional Interface:
This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface @Generated("org.javagi.JavaGI") public interface FileReadMoreCallback extends FunctionPointer

Functional interface declaration of the FileReadMoreCallback callback.

See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    run(String fileContents, long fileSize, @Nullable MemorySegment callbackData)
    When loading the partial contents of a file with g_file_load_partial_contents_async(), it may become necessary to determine if any more data from the file should be loaded.
    default MemorySegment
    toCallback(Arena arena)
    Creates a native function pointer to the upcall(MemorySegment, long, MemorySegment) method.
    default int
    upcall(MemorySegment fileContents, long fileSize, MemorySegment callbackData)
    The upcall method is called from native code.

  • Method Details

    • run

      boolean run(String fileContents, long fileSize, @Nullable MemorySegment callbackData)
      When loading the partial contents of a file with g_file_load_partial_contents_async(), it may become necessary to determine if any more data from the file should be loaded. A GFileReadMoreCallback function facilitates this by returning true if more data should be read, or false otherwise.
      Parameters:
      fileContents - the data as currently read.
      fileSize - the size of the data currently read.
      callbackData - data passed to the callback.
      Returns:
      true if more data should be read back. false otherwise.

    • upcall

      default int upcall(MemorySegment fileContents, long fileSize, MemorySegment callbackData)
      The upcall method is called from native code. The parameters are marshaled and run(String, long, MemorySegment) is executed.

    • toCallback

      default MemorySegment toCallback(Arena arena)
      Creates a native function pointer to the upcall(MemorySegment, long, MemorySegment) method.
      Specified by:
      toCallback in interface FunctionPointer
      Parameters:
      arena - the arena in which the function pointer is allocated
      Returns:
      the native function pointer