Uses of Interface
jdk.incubator.foreign.MemoryLayout

Packages that use MemoryLayout

Package	Description
jdk.incubator.foreign	Classes to support low-level and efficient foreign memory/function access, directly from Java.

Uses of MemoryLayout in jdk.incubator.foreign

Classes in jdk.incubator.foreign that implement MemoryLayout

Modifier and Type	Class	Description
final class	GroupLayout	A group layout is used to combine multiple member layouts.
final class	SequenceLayout	A sequence layout.
class	ValueLayout	A value layout.
static final class	ValueLayout.OfAddress	A value layout whose carrier is MemoryAddress.class.
static final class	ValueLayout.OfBoolean	A value layout whose carrier is boolean.class.
static final class	ValueLayout.OfByte	A value layout whose carrier is byte.class.
static final class	ValueLayout.OfChar	A value layout whose carrier is char.class.
static final class	ValueLayout.OfDouble	A value layout whose carrier is double.class.
static final class	ValueLayout.OfFloat	A value layout whose carrier is float.class.
static final class	ValueLayout.OfInt	A value layout whose carrier is int.class.
static final class	ValueLayout.OfLong	A value layout whose carrier is long.class.
static final class	ValueLayout.OfShort	A value layout whose carrier is short.class.

Methods in jdk.incubator.foreign that return MemoryLayout

Modifier and Type	Method	Description
MemoryLayout	SequenceLayout.elementLayout()	Returns the element layout associated with this sequence layout.
default MemoryLayout	MemoryLayout.map(UnaryOperator<MemoryLayout> op, MemoryLayout.PathElement... elements)	Creates a transformed copy of this layout where a selected layout, from a path rooted in this layout, is replaced with the result of applying the given operation.
static MemoryLayout	MemoryLayout.paddingLayout(long size)	Create a new padding layout with given size.
default MemoryLayout	MemoryLayout.select(MemoryLayout.PathElement... elements)	Selects the layout from a path rooted in this layout.
MemoryLayout	MemoryLayout.withBitAlignment(long bitAlignment)	Creates a new layout which features the desired alignment constraint.
MemoryLayout	MemoryLayout.withName(String name)	Creates a new layout which features the desired layout name.

Methods in jdk.incubator.foreign that return types with arguments of type MemoryLayout

Modifier and Type	Method	Description
List<MemoryLayout>	FunctionDescriptor.argumentLayouts()	Returns the argument layouts associated with this function descriptor.
Optional<? extends DynamicConstantDesc<? extends MemoryLayout>>	MemoryLayout.describeConstable()	Returns an Optional containing the nominal descriptor for this layout, if one can be constructed, or an empty Optional if one cannot be constructed.
List<MemoryLayout>	GroupLayout.memberLayouts()	Returns the member layouts associated with this group.
Optional<MemoryLayout>	FunctionDescriptor.returnLayout()	Returns the return layout (if any) associated with this function descriptor.

Methods in jdk.incubator.foreign with parameters of type MemoryLayout

Modifier and Type	Method	Description
default MemorySegment	SegmentAllocator.allocate(MemoryLayout layout)	Allocate a memory segment with given layout.
default MemorySegment	SegmentAllocator.allocateArray(MemoryLayout elementLayout, long count)	Allocate a memory segment with given element layout and size.
static MemorySegment	MemorySegment.allocateNative(MemoryLayout layout, ResourceScope scope)	Creates a new native memory segment that models a newly allocated block of off-heap memory with given layout and resource scope.
FunctionDescriptor	FunctionDescriptor.appendArgumentLayouts(MemoryLayout... addedLayouts)	Create a new function descriptor with the given argument layouts appended to the argument layout array of this function descriptor.
FunctionDescriptor	FunctionDescriptor.asVariadic(MemoryLayout... variadicLayouts)	Obtain a specialized variadic function descriptor, by appending given variadic layouts to this function descriptor argument layouts.
FunctionDescriptor	FunctionDescriptor.changeReturnLayout(MemoryLayout newReturn)	Create a new function descriptor with the given memory layout as the new return layout.
Stream<MemorySegment>	MemorySegment.elements(MemoryLayout elementLayout)	Returns a sequential Stream over disjoint slices (whose size matches that of the specified layout) in this segment.
FunctionDescriptor	FunctionDescriptor.insertArgumentLayouts(int index, MemoryLayout... addedLayouts)	Create a new function descriptor with the given argument layouts inserted at the given index, into the argument layout array of this function descriptor.
static FunctionDescriptor	FunctionDescriptor.of(MemoryLayout resLayout, MemoryLayout... argLayouts)	Create a function descriptor with given return and argument layouts.
static FunctionDescriptor	FunctionDescriptor.ofVoid(MemoryLayout... argLayouts)	Create a function descriptor with given argument layouts and no return layout.
static SequenceLayout	MemoryLayout.sequenceLayout(long elementCount, MemoryLayout elementLayout)	Create a new sequence layout with given element layout and element count.
static SequenceLayout	MemoryLayout.sequenceLayout(MemoryLayout elementLayout)	Create a new sequence layout, with unbounded element count and given element layout.
void	VaList.skip(MemoryLayout... layouts)	Skips a number of elements with the given memory layouts, and advances this variable argument list's position.
Spliterator<MemorySegment>	MemorySegment.spliterator(MemoryLayout elementLayout)	Returns a spliterator for this memory segment.
static GroupLayout	MemoryLayout.structLayout(MemoryLayout... elements)	Create a new struct group layout with given member layouts.
static GroupLayout	MemoryLayout.unionLayout(MemoryLayout... elements)	Create a new union group layout with given member layouts.

Method parameters in jdk.incubator.foreign with type arguments of type MemoryLayout

Modifier and Type	Method	Description
default MemoryLayout	MemoryLayout.map(UnaryOperator<MemoryLayout> op, MemoryLayout.PathElement... elements)	Creates a transformed copy of this layout where a selected layout, from a path rooted in this layout, is replaced with the result of applying the given operation.