Interface IteratorCopyFunction

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 IteratorCopyFunction
extends FunctionPointer

Functional interface declaration of the IteratorCopyFunction callback.

See Also:

• run(Iterator, Iterator)

Method Summary

Modifier and Type	Method	Description
void	run(Iterator it, Iterator copy)	This function will be called when creating a copy of it and should create a copy of all custom iterator fields or increase their reference counts.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, MemorySegment) method.
default void	upcall(MemorySegment it, MemorySegment copy)	The upcall method is called from native code.

Method Details

run

void run(Iterator it,
 Iterator copy)

This function will be called when creating a copy of it and should create a copy of all custom iterator fields or increase their reference counts.

Parameters:

it - The original iterator

copy - The copied iterator

upcall

default void upcall(MemorySegment it,
 MemorySegment copy)

The upcall method is called from native code. The parameters are marshaled and run(Iterator, Iterator) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

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

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer