Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class PointerPtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.PointerPtr

All Implemented Interfaces:

IPointer, Iterable<MemorySegment>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static @NotNull PointerPtr	allocate(@NotNull Arena arena)
static @NotNull PointerPtr	allocate(@NotNull Arena arena, long size)
static @NotNull PointerPtr	allocate(@NotNull Arena arena, Collection<@Nullable IPointer> pointers)
static @NotNull PointerPtr	allocateR(@NotNull Arena arena, Collection<@NotNull MemorySegment> segments)
static @NotNull PointerPtr	allocateStrings(@NotNull Arena arena, @Nullable String @NotNull [] strings)
static @NotNull PointerPtr	allocateStrings(@NotNull Arena arena, @Nullable String string0, @Nullable String @NotNull ... strings)
static @NotNull PointerPtr	allocateStrings(@NotNull Arena arena, @NotNull Collection<@Nullable String> strings)
static @NotNull PointerPtr	allocateV(@NotNull Arena arena, @Nullable IPointer pointer0, @Nullable IPointer... pointers)
static @NotNull PointerPtr	allocateV(@NotNull Arena arena, @NotNull MemorySegment segment0, @NotNull MemorySegment... segments)
static @Nullable PointerPtr	checked(@NotNull MemorySegment segment)
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.
@NotNull Iterator<MemorySegment>	iterator()
@NotNull PointerPtr	offset(long offset)
@NotNull MemorySegment	read()
@NotNull MemorySegment	read(long index)
@NotNull PointerPtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull PointerPtr	slice(long end)
@NotNull PointerPtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(long index, @Nullable IPointer pointer)
void	write(long index, @NotNull MemorySegment value)
void	write(@Nullable IPointer pointer)
void	write(@NotNull MemorySegment value)

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

PointerPtr

public PointerPtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a PointerPtr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

@NotNull
public @NotNull MemorySegment read()

write

public void write(@NotNull
 @NotNull MemorySegment value)

write

public void write(@Nullable
 @Nullable IPointer pointer)

read

@NotNull
public @NotNull MemorySegment read(long index)

write

public void write(long index,
 @NotNull
 @NotNull MemorySegment value)

write

public void write(long index,
 @Nullable
 @Nullable IPointer pointer)

reinterpret

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

offset

@NotNull
public @NotNull PointerPtr offset(long offset)

slice

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

slice

@NotNull
public @NotNull PointerPtr slice(long end)

iterator

@NotNull
public @NotNull Iterator<MemorySegment> iterator()

Specified by:

iterator in interface Iterable<MemorySegment>

checked

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

allocate

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

allocate

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

allocate

@NotNull
public static @NotNull PointerPtr allocate(@NotNull
 @NotNull Arena arena,
 Collection<@Nullable IPointer> pointers)

allocateR

@NotNull
public static @NotNull PointerPtr allocateR(@NotNull
 @NotNull Arena arena,
 Collection<@NotNull MemorySegment> segments)

allocateV

@NotNull
public static @NotNull PointerPtr allocateV(@NotNull
 @NotNull Arena arena,
 @Nullable
 @Nullable IPointer pointer0,
 @Nullable
 @Nullable IPointer... pointers)

allocateV

@NotNull
public static @NotNull PointerPtr allocateV(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull MemorySegment segment0,
 @NotNull
 @NotNull MemorySegment... segments)

allocateStrings

@NotNull
public static @NotNull PointerPtr allocateStrings(@NotNull
 @NotNull Arena arena,
 @Nullable
 @Nullable String string0,
 @Nullable
 @Nullable String @NotNull ... strings)

allocateStrings

@NotNull
public static @NotNull PointerPtr allocateStrings(@NotNull
 @NotNull Arena arena,
 @Nullable
 @Nullable String @NotNull [] strings)

allocateStrings

@NotNull
public static @NotNull PointerPtr allocateStrings(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull Collection<@Nullable String> strings)

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