Package org.lwjgl.util.zstd

Class ZSTDBounds

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer
    public class ZSTDBounds
extends Struct
implements NativeResource

    Layout

    
 struct ZSTD_bounds {
     size_t error;
     int lowerBound;
     int upperBound;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • ERROR, LOWERBOUND, UPPERBOUND

        The struct member offsets.

    • Constructor Detail

      • ZSTDBounds

        public ZSTDBounds​(java.nio.ByteBuffer container)
        Creates a ZSTDBounds 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()
        Description copied from class: Struct
        Returns sizeof(struct).
        Specified by:
        sizeof in class Struct

      • error

        public long error()
        Returns the value of the error field.

      • lowerBound

        public int lowerBound()
        Returns the value of the lowerBound field.

      • upperBound

        public int upperBound()
        Returns the value of the upperBound field.

      • malloc

        public static ZSTDBounds malloc()
        Returns a new ZSTDBounds instance allocated with memAlloc. The instance must be explicitly freed.

      • calloc

        public static ZSTDBounds calloc()
        Returns a new ZSTDBounds instance allocated with memCalloc. The instance must be explicitly freed.

      • create

        public static ZSTDBounds create()
        Returns a new ZSTDBounds instance allocated with BufferUtils.

      • create

        public static ZSTDBounds create​(long address)
        Returns a new ZSTDBounds instance for the specified memory address.

      • createSafe

        @Nullable
public static ZSTDBounds createSafe​(long address)
        Like create, but returns null if address is NULL.

      • malloc

        public static ZSTDBounds.Buffer malloc​(int capacity)
        Returns a new ZSTDBounds.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • calloc

        public static ZSTDBounds.Buffer calloc​(int capacity)
        Returns a new ZSTDBounds.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity

      • create

        public static ZSTDBounds.Buffer create​(long address,
                                       int capacity)
        Create a ZSTDBounds.Buffer instance at the specified memory.
        Parameters:
        address - the memory address
        capacity - the buffer capacity

      • createSafe

        @Nullable
public static ZSTDBounds.Buffer createSafe​(long address,
                                           int capacity)
        Like create, but returns null if address is NULL.

      • mallocStack

        public static ZSTDBounds mallocStack()
        Returns a new ZSTDBounds instance allocated on the thread-local MemoryStack.

      • callocStack

        public static ZSTDBounds callocStack()
        Returns a new ZSTDBounds instance allocated on the thread-local MemoryStack and initializes all its bits to zero.

      • mallocStack

        public static ZSTDBounds mallocStack​(MemoryStack stack)
        Returns a new ZSTDBounds instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate

      • callocStack

        public static ZSTDBounds callocStack​(MemoryStack stack)
        Returns a new ZSTDBounds instance allocated on the specified MemoryStack and initializes all its bits to zero.
        Parameters:
        stack - the stack from which to allocate

      • callocStack

        public static ZSTDBounds.Buffer callocStack​(int capacity)
        Returns a new ZSTDBounds.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
        Parameters:
        capacity - the buffer capacity

      • callocStack

        public static ZSTDBounds.Buffer callocStack​(int capacity,
                                            MemoryStack stack)
        Returns a new ZSTDBounds.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

      • nerror

        public static long nerror​(long struct)
        Unsafe version of error().

      • nlowerBound

        public static int nlowerBound​(long struct)
        Unsafe version of lowerBound().

      • nupperBound

        public static int nupperBound​(long struct)
        Unsafe version of upperBound().