Interface SequenceIterCompareFunc

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

Functional interface declaration of the SequenceIterCompareFunc callback.

See Also:

• run(SequenceIter, SequenceIter, MemorySegment)

Method Summary

Modifier and Type	Method	Description
int	run(SequenceIter a, SequenceIter b, @Nullable MemorySegment data)	A GSequenceIterCompareFunc is a function used to compare iterators.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment) method.
default int	upcall(MemorySegment a, MemorySegment b, MemorySegment data)	The upcall method is called from native code.

Method Details

run

int run(SequenceIter a,
 SequenceIter b,
 @Nullable MemorySegment data)

A GSequenceIterCompareFunc is a function used to compare iterators. It must return zero if the iterators compare equal, a negative value if a comes before b, and a positive value if b comes before a.

Parameters:

a - a GSequenceIter

b - a GSequenceIter

data - user data

Returns:

zero if the iterators are equal, a negative value if a comes before b, and a positive value if b comes before a.

upcall

default int upcall(MemorySegment a,
 MemorySegment b,
 MemorySegment data)

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

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(MemorySegment, 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