Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class LongPtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.LongPtr

All Implemented Interfaces:

IPointer, Iterable<Long>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static @NotNull LongPtr	allocate(@NotNull Arena arena)
static @NotNull LongPtr	allocate(@NotNull Arena arena, long size)
static @NotNull LongPtr	allocate(@NotNull Arena arena, long @NotNull [] array)
static @NotNull LongPtr	allocate(@NotNull Arena arena, @NotNull LongBuffer buffer)
static @NotNull LongPtr	allocate(@NotNull Arena arena, Collection<Long> longs)
static @NotNull LongPtr	allocateV(@NotNull Arena arena, long value0, long... values)
static @Nullable LongPtr	checked(@NotNull MemorySegment segment)
static @NotNull LongPtr	checked(@NotNull LongBuffer 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.OfLong	iterator()
@NotNull LongPtr	offset(long offset)
long	read()
long	read(long index)
@NotNull LongPtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull LongPtr	slice(long end)
@NotNull LongPtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(long value)
void	write(long @NotNull [] array)
void	write(long index, long value)
void	writeV(long value0, long @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

LongPtr

public LongPtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a LongPtr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

public long read()

write

public void write(long value)

read

public long read(long index)

write

public void write(long index,
 long value)

write

public void write(long @NotNull [] array)

writeV

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

reinterpret

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

offset

@NotNull
public @NotNull LongPtr offset(long offset)

slice

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

slice

@NotNull
public @NotNull LongPtr slice(long end)

iterator

@NotNull
public PrimitiveIterator.OfLong iterator()

Specified by:

iterator in interface Iterable<Long>

checked

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

checked

@NotNull
public static @NotNull LongPtr checked(@NotNull
 @NotNull LongBuffer buffer)

allocate

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

allocate

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

allocate

@NotNull
public static @NotNull LongPtr allocate(@NotNull
 @NotNull Arena arena,
 long @NotNull [] array)

allocate

@NotNull
public static @NotNull LongPtr allocate(@NotNull
 @NotNull Arena arena,
 Collection<Long> longs)

allocateV

@NotNull
public static @NotNull LongPtr allocateV(@NotNull
 @NotNull Arena arena,
 long value0,
 long... values)

allocate

@NotNull
public static @NotNull LongPtr allocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull LongBuffer 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