Record Class SDL_AsyncIOOutcome

java.lang.Object

java.lang.Record

club.doki7.sdl3.datatype.SDL_AsyncIOOutcome

All Implemented Interfaces:

IPointer, ISDL_AsyncIOOutcome

@ValueBasedCandidate
@UnsafeConstructor
public record SDL_AsyncIOOutcome(@NotNull MemorySegment segment)
extends Record
implements ISDL_AsyncIOOutcome

Information about a completed asynchronous I/O request.

Since: This struct is available since SDL 3.2.0.

Structure

typedef struct SDL_AsyncIOOutcome {
    SDL_AsyncIO* asyncio;
    SDL_AsyncIOTaskType type;
    SDL_AsyncIOResult result;
    void* buffer;
    Uint64 offset;
    Uint64 bytes_requested;
    Uint64 bytes_transferred;
    void* userdata;
} SDL_AsyncIOOutcome;

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	SDL_AsyncIOOutcome.Ptr	Represents a pointer to / an array of null structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$asyncio
static final AddressLayout	LAYOUT$buffer
static final ValueLayout.OfLong	LAYOUT$bytes_requested
static final ValueLayout.OfLong	LAYOUT$bytes_transferred
static final ValueLayout.OfLong	LAYOUT$offset
static final ValueLayout.OfInt	LAYOUT$result
static final ValueLayout.OfInt	LAYOUT$type
static final AddressLayout	LAYOUT$userdata
static final long	OFFSET$asyncio
static final long	OFFSET$buffer
static final long	OFFSET$bytes_requested
static final long	OFFSET$bytes_transferred
static final long	OFFSET$offset
static final long	OFFSET$result
static final long	OFFSET$type
static final long	OFFSET$userdata
static final MemoryLayout.PathElement	PATH$asyncio
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$bytes_requested
static final MemoryLayout.PathElement	PATH$bytes_transferred
static final MemoryLayout.PathElement	PATH$offset
static final MemoryLayout.PathElement	PATH$result
static final MemoryLayout.PathElement	PATH$type
static final MemoryLayout.PathElement	PATH$userdata
static final long	SIZE$asyncio
static final long	SIZE$buffer
static final long	SIZE$bytes_requested
static final long	SIZE$bytes_transferred
static final long	SIZE$offset
static final long	SIZE$result
static final long	SIZE$type
static final long	SIZE$userdata

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static SDL_AsyncIOOutcome	allocate(Arena arena)
static SDL_AsyncIOOutcome.Ptr	allocate(Arena arena, long count)
@Nullable SDL_AsyncIO	asyncio()
SDL_AsyncIOOutcome	asyncio(@Nullable SDL_AsyncIO value)
MemorySegment	buffer()
SDL_AsyncIOOutcome	buffer(@Nullable IPointer pointer)
void	buffer(MemorySegment value)
long	bytes_requested()
SDL_AsyncIOOutcome	bytes_requested(long value)
long	bytes_transferred()
SDL_AsyncIOOutcome	bytes_transferred(long value)
static SDL_AsyncIOOutcome	clone(Arena arena, SDL_AsyncIOOutcome src)
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.
long	offset()
SDL_AsyncIOOutcome	offset(long value)
int	result()
SDL_AsyncIOOutcome	result(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
SDL_AsyncIOOutcome	type(int value)
MemorySegment	userdata()
SDL_AsyncIOOutcome	userdata(@Nullable IPointer pointer)
void	userdata(MemorySegment value)

Methods inherited from class java.lang.Object

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

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$asyncio

public static final MemoryLayout.PathElement PATH$asyncio

PATH$type

public static final MemoryLayout.PathElement PATH$type

PATH$result

public static final MemoryLayout.PathElement PATH$result

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

PATH$bytes_requested

public static final MemoryLayout.PathElement PATH$bytes_requested

PATH$bytes_transferred

public static final MemoryLayout.PathElement PATH$bytes_transferred

PATH$userdata

public static final MemoryLayout.PathElement PATH$userdata

LAYOUT$asyncio

public static final AddressLayout LAYOUT$asyncio

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$result

public static final ValueLayout.OfInt LAYOUT$result

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

LAYOUT$offset

public static final ValueLayout.OfLong LAYOUT$offset

LAYOUT$bytes_requested

public static final ValueLayout.OfLong LAYOUT$bytes_requested

LAYOUT$bytes_transferred

public static final ValueLayout.OfLong LAYOUT$bytes_transferred

LAYOUT$userdata

public static final AddressLayout LAYOUT$userdata

SIZE$asyncio

public static final long SIZE$asyncio

SIZE$type

public static final long SIZE$type

SIZE$result

public static final long SIZE$result

SIZE$buffer

public static final long SIZE$buffer

SIZE$offset

public static final long SIZE$offset

SIZE$bytes_requested

public static final long SIZE$bytes_requested

SIZE$bytes_transferred

public static final long SIZE$bytes_transferred

SIZE$userdata

public static final long SIZE$userdata

OFFSET$asyncio

public static final long OFFSET$asyncio

OFFSET$type

public static final long OFFSET$type

OFFSET$result

public static final long OFFSET$result

OFFSET$buffer

public static final long OFFSET$buffer

OFFSET$offset

public static final long OFFSET$offset

OFFSET$bytes_requested

public static final long OFFSET$bytes_requested

OFFSET$bytes_transferred

public static final long OFFSET$bytes_transferred

OFFSET$userdata

public static final long OFFSET$userdata

Constructor Details

SDL_AsyncIOOutcome

public SDL_AsyncIOOutcome(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a SDL_AsyncIOOutcome record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static SDL_AsyncIOOutcome allocate(Arena arena)

allocate

public static SDL_AsyncIOOutcome.Ptr allocate(Arena arena,
 long count)

clone

public static SDL_AsyncIOOutcome clone(Arena arena,
 SDL_AsyncIOOutcome src)

asyncio

@Nullable
public @Nullable SDL_AsyncIO asyncio()

asyncio

public SDL_AsyncIOOutcome asyncio(@Nullable
 @Nullable SDL_AsyncIO value)

type

@EnumType(SDL_AsyncIOTaskType.class)
public int type()

type

public SDL_AsyncIOOutcome type(@EnumType(SDL_AsyncIOTaskType.class)
 int value)

result

@EnumType(SDL_AsyncIOResult.class)
public int result()

result

public SDL_AsyncIOOutcome result(@EnumType(SDL_AsyncIOResult.class)
 int value)

buffer

@Pointer(comment="void*")
public MemorySegment buffer()

buffer

public void buffer(@Pointer(comment="void*")
 MemorySegment value)

buffer

public SDL_AsyncIOOutcome buffer(@Nullable
 @Nullable IPointer pointer)

offset

@NativeType("Uint64")
@Unsigned
public long offset()

offset

public SDL_AsyncIOOutcome offset(@NativeType("Uint64") @Unsigned
 long value)

bytes_requested

@NativeType("Uint64")
@Unsigned
public long bytes_requested()

bytes_requested

public SDL_AsyncIOOutcome bytes_requested(@NativeType("Uint64") @Unsigned
 long value)

bytes_transferred

@NativeType("Uint64")
@Unsigned
public long bytes_transferred()

bytes_transferred

public SDL_AsyncIOOutcome bytes_transferred(@NativeType("Uint64") @Unsigned
 long value)

userdata

@Pointer(comment="void*")
public MemorySegment userdata()

userdata

public void userdata(@Pointer(comment="void*")
 MemorySegment value)

userdata

public SDL_AsyncIOOutcome userdata(@Nullable
 @Nullable IPointer pointer)

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