Interface StructBinder<T>

All Superinterfaces:

GroupBinder<StructLayout, T>

public non-sealed interface StructBinder<T>
extends GroupBinder<StructLayout, T>

The binder class for struct interfaces.

Struct binder implementations can be created using the builder returned by ffmStruct.

Method Summary

Modifier and Type	Method	Description
default StructArray<T>	allocate(SegmentAllocator allocator, long elementCount)	Allocates a memory segment for the specified number of group instances using the specified segment allocator.
default StructArray<T>	allocate(SegmentStack stack, long elementCount)	Allocates a memory segment, with zero-initialization, for the specified number of group instances on the specified segment stack.
default StructBinder<T>	apply(MemorySegment array, long offset, Consumer<T> consumer)	Applies the specified consumer to the group instance mapped to the specified memory segment and offset.
default StructBinder<T>	applyAtIndex(MemorySegment segment, long index, Consumer<T> consumer)	Applies the specified consumer to the group instance mapped to the specified memory segment and index.
default StructArray<T>	array(MemorySegment segment)	Returns a group array mapped to the specified memory segment.
default StructArray<T>	array(MemorySegment segment, long index)	Returns a group array mapped to the specified memory segment and starting at the specified index.
default StructArray<T>	array(MemorySegment segment, long index, long elementCount)	Returns a group array mapped to the specified memory segment and starting at the specified index, with the specified element count.
default StructArray<T>	malloc(SegmentStack stack, long elementCount)	Allocates a memory segment, without zero-initialization, for the specified number of group instances on the specified segment stack.
default StructBinder<T>	set(MemorySegment segment, long offset, T value)	Sets the contents of the specified memory segment at the specified offset to the specified group value.
default StructBinder<T>	set(MemorySegment segment, T value)	Sets the contents of the specified memory segment to the specified group value.
default StructBinder<T>	setAtIndex(MemorySegment segment, long index, T value)	Sets the contents of the specified memory segment at the specified index to the specified group value.

Methods inherited from interface GroupBinder

addressOf, addressOfSafe, alignof, allocate, allocate, allocateSegment, allocateSegment, allocateSegment, allocateSegment, asSegment, asSlice, asSlice, clear, copy, forEach, get, get, getAtIndex, iterable, iterator, layout, malloc, mallocSegment, mallocSegment, ofAddress, ofAddressSafe, parallelStream, reinterpret, reinterpret, reinterpret, reinterpret, sizeof, spliterator, stream

Method Details

set

default StructBinder<T> set(MemorySegment segment,
 T value)

Description copied from interface: GroupBinder

Sets the contents of the specified memory segment to the specified group value.

Specified by:

set in interface GroupBinder<StructLayout, T>

Parameters:

segment - the memory segment

value - the group instance

Returns:

this binder

set

default StructBinder<T> set(MemorySegment segment,
 long offset,
 T value)

Description copied from interface: GroupBinder

Sets the contents of the specified memory segment at the specified offset to the specified group value.

Specified by:

set in interface GroupBinder<StructLayout, T>

Parameters:

segment - the memory segment

offset - the memory offset

value - the group instance

Returns:

this binder

setAtIndex

default StructBinder<T> setAtIndex(MemorySegment segment,
 long index,
 T value)

Description copied from interface: GroupBinder

Sets the contents of the specified memory segment at the specified index to the specified group value.

Specified by:

setAtIndex in interface GroupBinder<StructLayout, T>

Parameters:

segment - the memory segment

index - the element index

value - the group instance

Returns:

this binder

apply

default StructBinder<T> apply(MemorySegment array,
 long offset,
 Consumer<T> consumer)

Description copied from interface: GroupBinder

Applies the specified consumer to the group instance mapped to the specified memory segment and offset.

Specified by:

apply in interface GroupBinder<StructLayout, T>

Parameters:

array - the memory segment

offset - the offset of the group instance

consumer - the consumer to apply

Returns:

this binder

applyAtIndex

default StructBinder<T> applyAtIndex(MemorySegment segment,
 long index,
 Consumer<T> consumer)

Description copied from interface: GroupBinder

Applies the specified consumer to the group instance mapped to the specified memory segment and index.

Specified by:

applyAtIndex in interface GroupBinder<StructLayout, T>

Parameters:

segment - the memory segment

index - the index of the group instance

consumer - the consumer to apply

Returns:

this binder

array

default StructArray<T> array(MemorySegment segment)

Description copied from interface: GroupBinder

Returns a group array mapped to the specified memory segment.

Specified by:

array in interface GroupBinder<StructLayout, T>

Parameters:

segment - the memory segment

Returns:

the group array

array

default StructArray<T> array(MemorySegment segment,
 long index)

Description copied from interface: GroupBinder

Returns a group array mapped to the specified memory segment and starting at the specified index.

Specified by:

array in interface GroupBinder<StructLayout, T>

Parameters:

segment - the memory segment

index - the starting index

Returns:

the group array

array

default StructArray<T> array(MemorySegment segment,
 long index,
 long elementCount)

Description copied from interface: GroupBinder

Returns a group array mapped to the specified memory segment and starting at the specified index, with the specified element count.

Specified by:

array in interface GroupBinder<StructLayout, T>

Parameters:

segment - the memory segment

index - the starting index

elementCount - the number of elements

Returns:

the group array

malloc

default StructArray<T> malloc(SegmentStack stack,
 long elementCount)

Description copied from interface: GroupBinder

Allocates a memory segment, without zero-initialization, for the specified number of group instances on the specified segment stack.

Specified by:

malloc in interface GroupBinder<StructLayout, T>

Parameters:

stack - the segment stack

elementCount - the number of elements

Returns:

the group array

allocate

default StructArray<T> allocate(SegmentStack stack,
 long elementCount)

Description copied from interface: GroupBinder

Allocates a memory segment, with zero-initialization, for the specified number of group instances on the specified segment stack.

Specified by:

allocate in interface GroupBinder<StructLayout, T>

Parameters:

stack - the segment stack

elementCount - the number of elements

Returns:

the group array

allocate

default StructArray<T> allocate(SegmentAllocator allocator,
 long elementCount)

Description copied from interface: GroupBinder

Allocates a memory segment for the specified number of group instances using the specified segment allocator.

Specified by:

allocate in interface GroupBinder<StructLayout, T>

Parameters:

allocator - the segment allocator

elementCount - the number of elements

Returns:

the group array