TestFixtureFunc (java-gi API)

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("io.github.jwharm.JavaGI") public interface TestFixtureFunc extends FunctionPointer

Functional interface declaration of the TestFixtureFunc callback.

See Also:

Method Summary

Modifier and Type

Method

Description

void

run(MemorySegment fixture)

The type used for functions that operate on test fixtures.

default MemorySegment

toCallback(Arena arena)

Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.

default void

upcall(MemorySegment fixture, MemorySegment userData)

The upcall method is called from native code.

Method Details
- run
  
  void run(MemorySegment fixture)
  
  The type used for functions that operate on test fixtures. This is used for the fixture setup and teardown functions as well as for the testcases themselves.
  userData is a pointer to the data that was given when registering the test case.
  fixture will be a pointer to the area of memory allocated by the test framework, of the size requested. If the requested size was zero then fixture will be equal to userData.
- upcall
  
  default void upcall(MemorySegment fixture, MemorySegment userData)
  
  The upcall method is called from native code. The parameters are marshaled and run(java.lang.foreign.MemorySegment) is executed.
- toCallback
  
  default MemorySegment toCallback(Arena arena)
  
  Creates a native function pointer to the upcall(java.lang.foreign.MemorySegment, java.lang.foreign.MemorySegment) method.
  
  Specified by:
  
  toCallback in interface FunctionPointer
  
  Parameters:
  
  arena - the function pointer will be allocated in this arena
  
  Returns:
  
  the native function pointer