int vargAsInt(MemoryLayout layout)

Reads the next value as an int and advances this va list's position.

long vargAsLong(MemoryLayout layout)

Reads the next value as a long and advances this va list's position.

double vargAsDouble(MemoryLayout layout)

Reads the next value as a double and advances this va list's position.

MemoryAddress vargAsAddress(MemoryLayout layout)

Reads the next value as a MemoryAddress and advances this va list's position.

MemorySegment vargAsSegment(MemoryLayout layout, SegmentAllocator allocator)

Reads the next value as a MemorySegment, and advances this va list's position.

The memory segment returned by this method will be allocated using the given SegmentAllocator.

MemorySegment vargAsSegment(MemoryLayout layout, ResourceScope scope)

Reads the next value as a MemorySegment, and advances this va list's position.

The memory segment returned by this method will be associated with the given ResourceScope.

void skip(MemoryLayout... layouts)

Skips a number of elements with the given memory layouts, and advances this va list's position.

ResourceScope scope()

Returns the resource scope associated with this instance.

CLinker.VaList copy()

Copies this C va_list at its current position. Copying is useful to traverse the va list's elements starting from the current position, without affecting the state of the original va list, essentially allowing the elements to be traversed multiple times.

Any native resource required by the execution of this method will be allocated in the resource scope associated with this instance (see scope()).

This method only copies the va list cursor itself and not the memory that may be attached to the va list which holds its elements. That means that if this va list was created with the make(Consumer, ResourceScope) method, closing this va list will also release the native memory that holds its elements, making the copy unusable.

MemoryAddress address()

Returns the memory address of the C va_list associated with this instance. The returned memory address is associated with same resource scope as that associated with this instance.

static CLinker.VaList ofAddress(MemoryAddress address)

Constructs a new VaList instance out of a memory address pointing to an existing C va_list, backed by the global resource scope.

This method is restricted. Restricted methods are unsafe, and, if used incorrectly, their use might crash the JVM or, worse, silently result in memory corruption. Thus, clients should refrain from depending on restricted methods, and use safe and supported functionalities, where possible.

static CLinker.VaList ofAddress(MemoryAddress address, ResourceScope scope)

Constructs a new VaList instance out of a memory address pointing to an existing C va_list, with given resource scope.

This method is restricted. Restricted methods are unsafe, and, if used incorrectly, their use might crash the JVM or, worse, silently result in memory corruption. Thus, clients should refrain from depending on restricted methods, and use safe and supported functionalities, where possible.

static CLinker.VaList make(Consumer<CLinker.VaList.Builder> actions, ResourceScope scope)

Constructs a new VaList using a builder (see CLinker.VaList.Builder), associated with a given resource scope.

If this method needs to allocate native memory, such memory will be managed by the given resource scope, and will be released when the resource scope is closed.

Note that when there are no elements added to the created va list, this method will return the same as empty().

static CLinker.VaList empty()

Returns an empty C va_list constant.

The returned VaList can not be closed.