Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class BytePtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.BytePtr

All Implemented Interfaces:

IPointer, Iterable<Byte>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static @NotNull BytePtr	allocate(@NotNull Arena arena)
static @NotNull BytePtr	allocate(@NotNull Arena arena, byte @NotNull [] bytes)
static @NotNull BytePtr	allocate(@NotNull Arena arena, long size)
static @NotNull BytePtr	allocate(@NotNull Arena arena, @NotNull ByteBuffer buffer)
static @NotNull BytePtr	allocate(@NotNull Arena arena, Collection<Byte> bytes)
static @NotNull BytePtr	allocateAligned(@NotNull Arena arena, long size, long alignment)
static @NotNull BytePtr	allocateString(@NotNull Arena arena, @NotNull String s)
static @NotNull BytePtr	allocateV(@NotNull Arena arena, byte value0, byte... values)
static @Nullable BytePtr	checked(@NotNull MemorySegment segment)
static @NotNull BytePtr	checked(@NotNull ByteBuffer buffer)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static @NotNull BytePtr	from(@NotNull IPointer ptr)
final int	hashCode()	Returns a hash code value for this object.
@NotNull Iterator<Byte>	iterator()
@NotNull BytePtr	offset(long offset)
byte	read()
byte	read(long index)
@NotNull String	readString()
@NotNull String	readStringSafe()
@NotNull BytePtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull BytePtr	slice(long end)
@NotNull BytePtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(byte value)
void	write(byte @NotNull [] bytes)
void	write(long index, byte value)
void	writeString(@NotNull String s)
void	writeV(byte value0, byte @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

BytePtr

public BytePtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a BytePtr record class.

Parameters:

segment - the value for the segment record component

Method Details

size

public long size()

read

public byte read()

write

public void write(byte value)

read

public byte read(long index)

write

public void write(long index,
 byte value)

write

public void write(byte @NotNull [] bytes)

writeV

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

writeString

public void writeString(@NotNull
 @NotNull String s)

readStringSafe

@NotNull
public @NotNull String readStringSafe()

readString

@Unsafe
@NotNull
public @NotNull String readString()

reinterpret

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

offset

@NotNull
public @NotNull BytePtr offset(long offset)

slice

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

slice

@NotNull
public @NotNull BytePtr slice(long end)

iterator

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

Specified by:

iterator in interface Iterable<Byte>

checked

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

checked

@NotNull
public static @NotNull BytePtr checked(@NotNull
 @NotNull ByteBuffer buffer)

from

@NotNull
public static @NotNull BytePtr from(@NotNull
 @NotNull IPointer ptr)

allocate

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

allocate

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

allocate

@NotNull
public static @NotNull BytePtr allocate(@NotNull
 @NotNull Arena arena,
 byte @NotNull [] bytes)

allocate

@NotNull
public static @NotNull BytePtr allocate(@NotNull
 @NotNull Arena arena,
 Collection<Byte> bytes)

allocateV

@NotNull
public static @NotNull BytePtr allocateV(@NotNull
 @NotNull Arena arena,
 byte value0,
 byte... values)

allocate

@NotNull
public static @NotNull BytePtr allocate(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull ByteBuffer buffer)

allocateAligned

@NotNull
public static @NotNull BytePtr allocateAligned(@NotNull
 @NotNull Arena arena,
 long size,
 long alignment)

allocateString

@NotNull
public static @NotNull BytePtr allocateString(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull String s)

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