Class LZ4FDecompressOptions

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<LZ4FDecompressOptions>

org.lwjgl.util.lz4.LZ4FDecompressOptions

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

@NativeType("struct LZ4F_decompressOptions_t")
public class LZ4FDecompressOptions
extends Struct<LZ4FDecompressOptions>
implements NativeResource

struct LZ4F_decompressOptions_t {
    unsigned stableDst;
    unsigned skipChecksums;
    unsigned reserved1;
    unsigned reserved0;
}

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LZ4FDecompressOptions.Buffer	An array of LZ4FDecompressOptions structs.

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	RESERVED0	The struct member offsets.
static final int	RESERVED1	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SKIPCHECKSUMS	The struct member offsets.
static final int	STABLEDST	The struct member offsets.

Fields inherited from interface Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
LZ4FDecompressOptions(ByteBuffer container)	Creates a LZ4FDecompressOptions instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static LZ4FDecompressOptions	calloc()	Returns a new LZ4FDecompressOptions instance allocated with memCalloc.
static LZ4FDecompressOptions.Buffer	calloc(int capacity)	Returns a new LZ4FDecompressOptions.Buffer instance allocated with memCalloc.
static LZ4FDecompressOptions.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new LZ4FDecompressOptions.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static LZ4FDecompressOptions	calloc(MemoryStack stack)	Returns a new LZ4FDecompressOptions instance allocated on the specified MemoryStack and initializes all its bits to zero.
static LZ4FDecompressOptions	create()	Returns a new LZ4FDecompressOptions instance allocated with BufferUtils.
static LZ4FDecompressOptions.Buffer	create(int capacity)	Returns a new LZ4FDecompressOptions.Buffer instance allocated with BufferUtils.
static LZ4FDecompressOptions	create(long address)	Returns a new LZ4FDecompressOptions instance for the specified memory address.
static LZ4FDecompressOptions.Buffer	create(long address, int capacity)	Create a LZ4FDecompressOptions.Buffer instance at the specified memory.
static @Nullable LZ4FDecompressOptions	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable LZ4FDecompressOptions.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static LZ4FDecompressOptions	malloc()	Returns a new LZ4FDecompressOptions instance allocated with memAlloc.
static LZ4FDecompressOptions.Buffer	malloc(int capacity)	Returns a new LZ4FDecompressOptions.Buffer instance allocated with memAlloc.
static LZ4FDecompressOptions.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new LZ4FDecompressOptions.Buffer instance allocated on the specified MemoryStack.
static LZ4FDecompressOptions	malloc(MemoryStack stack)	Returns a new LZ4FDecompressOptions instance allocated on the specified MemoryStack.
static int	nreserved0(long struct)	Unsafe version of reserved0().
static void	nreserved0(long struct, int value)	Unsafe version of reserved0.
static int	nreserved1(long struct)	Unsafe version of reserved1().
static void	nreserved1(long struct, int value)	Unsafe version of reserved1.
static int	nskipChecksums(long struct)	Unsafe version of skipChecksums().
static void	nskipChecksums(long struct, int value)	Unsafe version of skipChecksums.
static int	nstableDst(long struct)	Unsafe version of stableDst().
static void	nstableDst(long struct, int value)	Unsafe version of stableDst.
int	reserved0()
LZ4FDecompressOptions	reserved0(int value)	Sets the specified value to the reserved0 field.
int	reserved1()
LZ4FDecompressOptions	reserved1(int value)	Sets the specified value to the reserved1 field.
LZ4FDecompressOptions	set(int stableDst, int skipChecksums, int reserved1, int reserved0)	Initializes this struct with the specified values.
LZ4FDecompressOptions	set(LZ4FDecompressOptions src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	skipChecksums()
LZ4FDecompressOptions	skipChecksums(int value)	Sets the specified value to the skipChecksums field.
int	stableDst()
LZ4FDecompressOptions	stableDst(int value)	Sets the specified value to the stableDst field.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

STABLEDST

public static final int STABLEDST

The struct member offsets.

SKIPCHECKSUMS

public static final int SKIPCHECKSUMS

The struct member offsets.

RESERVED1

public static final int RESERVED1

The struct member offsets.

RESERVED0

public static final int RESERVED0

The struct member offsets.

Constructor Details

LZ4FDecompressOptions

public LZ4FDecompressOptions(ByteBuffer container)

Creates a LZ4FDecompressOptions instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<LZ4FDecompressOptions>

stableDst

@NativeType("unsigned")
public int stableDst()

Returns:

the value of the stableDst field.

skipChecksums

@NativeType("unsigned")
public int skipChecksums()

Returns:

the value of the skipChecksums field.

reserved1

@NativeType("unsigned")
public int reserved1()

Returns:

the value of the reserved1 field.

reserved0

@NativeType("unsigned")
public int reserved0()

Returns:

the value of the reserved0 field.

stableDst

public LZ4FDecompressOptions stableDst(@NativeType("unsigned")
 int value)

Sets the specified value to the stableDst field.

skipChecksums

public LZ4FDecompressOptions skipChecksums(@NativeType("unsigned")
 int value)

Sets the specified value to the skipChecksums field.

reserved1

public LZ4FDecompressOptions reserved1(@NativeType("unsigned")
 int value)

Sets the specified value to the reserved1 field.

reserved0

public LZ4FDecompressOptions reserved0(@NativeType("unsigned")
 int value)

Sets the specified value to the reserved0 field.

set

public LZ4FDecompressOptions set(int stableDst,
 int skipChecksums,
 int reserved1,
 int reserved0)

Initializes this struct with the specified values.

set

public LZ4FDecompressOptions set(LZ4FDecompressOptions src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static LZ4FDecompressOptions malloc()

Returns a new LZ4FDecompressOptions instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static LZ4FDecompressOptions calloc()

Returns a new LZ4FDecompressOptions instance allocated with memCalloc. The instance must be explicitly freed.

create

public static LZ4FDecompressOptions create()

Returns a new LZ4FDecompressOptions instance allocated with BufferUtils.

create

public static LZ4FDecompressOptions create(long address)

Returns a new LZ4FDecompressOptions instance for the specified memory address.

createSafe

public static @Nullable LZ4FDecompressOptions createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static LZ4FDecompressOptions.Buffer malloc(int capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static LZ4FDecompressOptions.Buffer calloc(int capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static LZ4FDecompressOptions.Buffer create(int capacity)

Returns a new LZ4FDecompressOptions.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static LZ4FDecompressOptions.Buffer create(long address,
 int capacity)

Create a LZ4FDecompressOptions.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable LZ4FDecompressOptions.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static LZ4FDecompressOptions malloc(MemoryStack stack)

Returns a new LZ4FDecompressOptions instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static LZ4FDecompressOptions calloc(MemoryStack stack)

Returns a new LZ4FDecompressOptions instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static LZ4FDecompressOptions.Buffer malloc(int capacity,
 MemoryStack stack)

Returns a new LZ4FDecompressOptions.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static LZ4FDecompressOptions.Buffer calloc(int capacity,
 MemoryStack stack)

Returns a new LZ4FDecompressOptions.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

nstableDst

public static int nstableDst(long struct)

Unsafe version of stableDst().

nskipChecksums

public static int nskipChecksums(long struct)

Unsafe version of skipChecksums().

nreserved1

public static int nreserved1(long struct)

Unsafe version of reserved1().

nreserved0

public static int nreserved0(long struct)

Unsafe version of reserved0().

nstableDst

public static void nstableDst(long struct,
 int value)

Unsafe version of stableDst.

nskipChecksums

public static void nskipChecksums(long struct,
 int value)

Unsafe version of skipChecksums.

nreserved1

public static void nreserved1(long struct,
 int value)

Unsafe version of reserved1.

nreserved0

public static void nreserved0(long struct,
 int value)

Unsafe version of reserved0.