ZSTDSequence (LWJGL 3.2.4 SNAPSHOT

java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.util.zstd.ZSTDSequence

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class ZSTDSequence
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Member documentation
- matchPos – match pos in dst
- offset – if seqDef.offset > 3, then this is seqDef.offset - 3. If seqDef.offset < 3, then this is the corresponding repeat offset. But if seqDef.offset < 3 and litLength == 0, this is the repeat offset before the corresponding repeat offset. And if seqDef.offset == 3 and litLength == 0, this is the most recent repeat offset - 1.
- litLength – literal length
- matchLength – match length
- rep – 0 when seq not rep and seqDef.offset otherwise when litLength == 0 this will be <= 4,otherwise <= 3 like normal.
Layout
```
 struct ZSTD_Sequence {
     unsigned int matchPos;
     unsigned int offset;
     unsigned int litLength;
     unsigned int matchLength;
     unsigned int rep;
 }
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ZSTDSequence.Buffer
An array of ZSTDSequence structs.
- Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`ZSTDSequence.Buffer` An array of `ZSTDSequence` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`LITLENGTH` The struct member offsets.
`static int`	`MATCHLENGTH` The struct member offsets.
`static int`	`MATCHPOS` The struct member offsets.
`static int`	`OFFSET` The struct member offsets.
`static int`	`REP` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors
Constructor and Description

ZSTDSequence(java.nio.ByteBuffer container)
Creates a ZSTDSequence instance at the current position of the specified ByteBuffer container.

Constructors
Constructor and Description
`ZSTDSequence(java.nio.ByteBuffer container)` Creates a `ZSTDSequence` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ZSTDSequence`	`calloc()` Returns a new `ZSTDSequence` instance allocated with `memCalloc`.
`static ZSTDSequence.Buffer`	`calloc(int capacity)` Returns a new `ZSTDSequence.Buffer` instance allocated with `memCalloc`.
`static ZSTDSequence`	`callocStack()` Returns a new `ZSTDSequence` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDSequence.Buffer`	`callocStack(int capacity)` Returns a new `ZSTDSequence.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static ZSTDSequence.Buffer`	`callocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDSequence.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDSequence`	`callocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDSequence` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static ZSTDSequence`	`create()` Returns a new `ZSTDSequence` instance allocated with `BufferUtils`.
`static ZSTDSequence.Buffer`	`create(int capacity)` Returns a new `ZSTDSequence.Buffer` instance allocated with `BufferUtils`.
`static ZSTDSequence`	`create(long address)` Returns a new `ZSTDSequence` instance for the specified memory address.
`static ZSTDSequence.Buffer`	`create(long address, int capacity)` Create a `ZSTDSequence.Buffer` instance at the specified memory.
`static ZSTDSequence`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static ZSTDSequence.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`int`	`litLength()` Returns the value of the `litLength` field.
`static ZSTDSequence`	`malloc()` Returns a new `ZSTDSequence` instance allocated with `memAlloc`.
`static ZSTDSequence.Buffer`	`malloc(int capacity)` Returns a new `ZSTDSequence.Buffer` instance allocated with `memAlloc`.
`static ZSTDSequence`	`mallocStack()` Returns a new `ZSTDSequence` instance allocated on the thread-local `MemoryStack`.
`static ZSTDSequence.Buffer`	`mallocStack(int capacity)` Returns a new `ZSTDSequence.Buffer` instance allocated on the thread-local `MemoryStack`.
`static ZSTDSequence.Buffer`	`mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDSequence.Buffer` instance allocated on the specified `MemoryStack`.
`static ZSTDSequence`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `ZSTDSequence` instance allocated on the specified `MemoryStack`.
`int`	`matchLength()` Returns the value of the `matchLength` field.
`int`	`matchPos()` Returns the value of the `matchPos` field.
`static int`	`nlitLength(long struct)` Unsafe version of `litLength()`.
`static int`	`nmatchLength(long struct)` Unsafe version of `matchLength()`.
`static int`	`nmatchPos(long struct)` Unsafe version of `matchPos()`.
`static int`	`noffset(long struct)` Unsafe version of `offset()`.
`static int`	`nrep(long struct)` Unsafe version of `rep()`.
`int`	`offset()` Returns the value of the `offset` field.
`int`	`rep()` Returns the value of the `rep` field.
`int`	`sizeof()`

Methods inherited from class org.lwjgl.system.Struct
clear, free, isNull

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - MATCHPOS
```
public static final int MATCHPOS
```
    The struct member offsets.
  - OFFSET
```
public static final int OFFSET
```
    The struct member offsets.
  - LITLENGTH
```
public static final int LITLENGTH
```
    The struct member offsets.
  - MATCHLENGTH
```
public static final int MATCHLENGTH
```
    The struct member offsets.
  - REP
```
public static final int REP
```
    The struct member offsets.
- Constructor Detail
  - ZSTDSequence
```
public ZSTDSequence(java.nio.ByteBuffer container)
```
    Creates a ZSTDSequence 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 Detail
  - sizeof
```
public int sizeof()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.Struct
  - matchPos
```
public int matchPos()
```
    Returns the value of the matchPos field.
  - offset
```
public int offset()
```
    Returns the value of the offset field.
  - litLength
```
public int litLength()
```
    Returns the value of the litLength field.
  - matchLength
```
public int matchLength()
```
    Returns the value of the matchLength field.
  - rep
```
public int rep()
```
    Returns the value of the rep field.
  - malloc
```
public static ZSTDSequence malloc()
```
    Returns a new ZSTDSequence instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static ZSTDSequence calloc()
```
    Returns a new ZSTDSequence instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static ZSTDSequence create()
```
    Returns a new ZSTDSequence instance allocated with BufferUtils.
  - create
```
public static ZSTDSequence create(long address)
```
    Returns a new ZSTDSequence instance for the specified memory address.
  - createSafe
```
@Nullable
public static ZSTDSequence createSafe(long address)
```
    Like create, but returns null if address is NULL.
  - malloc
```
public static ZSTDSequence.Buffer malloc(int capacity)
```
    Returns a new ZSTDSequence.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static ZSTDSequence.Buffer calloc(int capacity)
```
    Returns a new ZSTDSequence.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDSequence.Buffer create(int capacity)
```
    Returns a new ZSTDSequence.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static ZSTDSequence.Buffer create(long address,
                                         int capacity)
```
    Create a ZSTDSequence.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - createSafe
```
@Nullable
public static ZSTDSequence.Buffer createSafe(long address,
                                                       int capacity)
```
    Like create, but returns null if address is NULL.
  - mallocStack
```
public static ZSTDSequence mallocStack()
```
    Returns a new ZSTDSequence instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static ZSTDSequence callocStack()
```
    Returns a new ZSTDSequence instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static ZSTDSequence mallocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDSequence instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static ZSTDSequence callocStack(org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDSequence instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static ZSTDSequence.Buffer mallocStack(int capacity)
```
    Returns a new ZSTDSequence.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDSequence.Buffer callocStack(int capacity)
```
    Returns a new ZSTDSequence.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static ZSTDSequence.Buffer mallocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDSequence.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static ZSTDSequence.Buffer callocStack(int capacity,
                                              org.lwjgl.system.MemoryStack stack)
```
    Returns a new ZSTDSequence.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - nmatchPos
```
public static int nmatchPos(long struct)
```
    Unsafe version of matchPos().
  - noffset
```
public static int noffset(long struct)
```
    Unsafe version of offset().
  - nlitLength
```
public static int nlitLength(long struct)
```
    Unsafe version of litLength().
  - nmatchLength
```
public static int nmatchLength(long struct)
```
    Unsafe version of matchLength().
  - nrep
```
public static int nrep(long struct)
```
    Unsafe version of rep().

Class ZSTDSequence

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

ALIGNOF

MATCHPOS

OFFSET

LITLENGTH

MATCHLENGTH

REP

Constructor Detail

ZSTDSequence

Method Detail

sizeof

matchPos

offset

litLength

matchLength

rep

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nmatchPos

noffset

nlitLength

nmatchLength

nrep