Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class IntPtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.IntPtr

All Implemented Interfaces:

IPointer, Iterable<Integer>

@ValueBasedCandidate
@UnsafeConstructor
public record IntPtr(@NotNull MemorySegment segment)
extends Record
implements IPointer, Iterable<Integer>

Constructor Summary

Constructors

Constructor	Description
IntPtr(@NotNull MemorySegment segment)	Creates an instance of a IntPtr record class.

Method Summary

Modifier and Type	Method	Description
static @NotNull IntPtr	allocate(@NotNull Arena arena)
static @NotNull IntPtr	allocate(@NotNull Arena arena, byte @NotNull [] array)
static @NotNull IntPtr	allocate(@NotNull Arena arena, int @NotNull [] array)
static @NotNull IntPtr	allocate(@NotNull Arena arena, long size)
static @NotNull IntPtr	allocate(@NotNull Arena arena, @NotNull IntBuffer buffer)
static @NotNull IntPtr	allocate(@NotNull Arena arena, Collection<Integer> ints)
static @NotNull IntPtr	allocateV(@NotNull Arena arena, int value0, int... values)
static @Nullable IntPtr	checked(@NotNull MemorySegment segment)
static @NotNull IntPtr	checked(@NotNull IntBuffer buffer)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
PrimitiveIterator.OfInt	iterator()
@NotNull IntPtr	offset(long offset)
int	read()
int	read(long index)
@NotNull IntPtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull IntPtr	slice(long end)
@NotNull IntPtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(int value)
void	write(int @NotNull [] array)
void	write(long index, int value)
void	writeV(int value0, int @NotNull ... values)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

IntPtr

public IntPtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a IntPtr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

public int read()

write

public void write(int value)

read

public int read(long index)

write

public void write(long index,
 int value)

write

public void write(int @NotNull [] array)

writeV

public void writeV(int value0,
 int @NotNull ... values)

reinterpret

@Unsafe
@NotNull
public @NotNull IntPtr reinterpret(long newSize)

offset

@NotNull
public @NotNull IntPtr offset(long offset)

slice

@NotNull
public @NotNull IntPtr slice(long start,
 long end)

slice

@NotNull
public @NotNull IntPtr slice(long end)

iterator

@NotNull
public PrimitiveIterator.OfInt iterator()

Specified by:

iterator in interface Iterable<Integer>

checked

@Nullable
public static @Nullable IntPtr checked(@NotNull
 @NotNull MemorySegment segment)

checked

@NotNull
public static @NotNull IntPtr checked(@NotNull
 @NotNull IntBuffer buffer)

allocate

@NotNull
public static @NotNull IntPtr allocate(@NotNull
 @NotNull Arena arena)

allocate

@NotNull
public static @NotNull IntPtr allocate(@NotNull
 @NotNull Arena arena,
 long size)

allocate

@NotNull
public static @NotNull IntPtr allocate(@NotNull
 @NotNull Arena arena,
 int @NotNull [] array)

allocate

@NotNull
public static @NotNull IntPtr allocate(@NotNull
 @NotNull Arena arena,
 Collection<Integer> ints)

allocateV

@NotNull
public static @NotNull IntPtr allocateV(@NotNull
 @NotNull Arena arena,
 int value0,
 int... values)

allocate

@NotNull
public static @NotNull IntPtr allocate(@NotNull
 @NotNull Arena arena,
 byte @NotNull [] array)

allocate

@NotNull
public static @NotNull IntPtr allocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull IntBuffer buffer)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component