Module club.doki7.ffm

Package club.doki7.ffm.ptr

Record Class WCharPtr

java.lang.Object

java.lang.Record

club.doki7.ffm.ptr.WCharPtr

All Implemented Interfaces:

IPointer, Iterable<Integer>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static @NotNull WCharPtr	allocate(@NotNull Arena arena)
static @NotNull WCharPtr	allocate(@NotNull Arena arena, long size)
static @NotNull WCharPtr	allocateWString(@NotNull Arena arena, @NotNull String string)
static @Nullable WCharPtr	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.
PrimitiveIterator.OfInt	iterator()
@NotNull WCharPtr	offset(long offset)
int	read()
int	read(long index)
@NotNull String	readWString()
@NotNull String	readWStringSafe()
@NotNull WCharPtr	reinterpret(long newSize)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
@NotNull WCharPtr	slice(long end)
@NotNull WCharPtr	slice(long start, long end)
final String	toString()	Returns a string representation of this record class.
void	write(int value)
void	write(long index, int 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

WCharPtr

public WCharPtr(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a WCharPtr 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)

readWStringSafe

@NotNull
public @NotNull String readWStringSafe()

readWString

@Unsafe
@NotNull
public @NotNull String readWString()

reinterpret

@NotNull
public @NotNull WCharPtr reinterpret(long newSize)

offset

@NotNull
public @NotNull WCharPtr offset(long offset)

slice

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

slice

@NotNull
public @NotNull WCharPtr slice(long end)

iterator

@NotNull
public PrimitiveIterator.OfInt iterator()

Specified by:

iterator in interface Iterable<Integer>

checked

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

allocate

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

allocate

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

allocateWString

@NotNull
public static @NotNull WCharPtr allocateWString(@NotNull
 @NotNull Arena arena,
 @NotNull
 @NotNull String string)

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