Package org.lwjgl.util.zstd

Class ZSTDInBuffer

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

    Member documentation

    • src – start of input buffer
    • size – size of input buffer
    • pos – position where reading stopped. Will be updated. Necessarily 0 ≤ pos ≤ size

    Layout

    
 struct ZSTD_inBuffer {
     void const * src;
     size_t size;
     size_t pos;
 }

    • Field Detail

      • SIZEOF

        The struct size in bytes.

      • ALIGNOF

        The struct alignment in bytes.

      • SRC, SIZE, POS

        The struct member offsets.

    • Constructor Detail

      • ZSTDInBuffer

        public ZSTDInBuffer​(java.nio.ByteBuffer container)
        Creates a ZSTDInBuffer 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

      • src

        public java.nio.ByteBuffer src()
        Returns a ByteBuffer view of the data pointed to by the src field.

      • size

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

      • pos

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

      • src

        public ZSTDInBuffer src​(java.nio.ByteBuffer value)
        Sets the address of the specified ByteBuffer to the src field.

      • pos

        public ZSTDInBuffer pos​(long value)
        Sets the specified value to the pos field.

      • set

        public ZSTDInBuffer set​(java.nio.ByteBuffer src,
                        long pos)
        Initializes this struct with the specified values.

      • set

        public ZSTDInBuffer set​(ZSTDInBuffer src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct

      • malloc

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

      • calloc

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

      • create

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

      • createSafe

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

      • create

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

      • createSafe

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

      • mallocStack

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

      • callocStack

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

      • mallocStack

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

      • callocStack

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

      • callocStack

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

      • callocStack

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

      • nsrc

        public static java.nio.ByteBuffer nsrc​(long struct)
        Unsafe version of src.

      • nsize

        public static long nsize​(long struct)
        Unsafe version of size().

      • npos

        public static long npos​(long struct)
        Unsafe version of pos().

      • nsrc

        public static void nsrc​(long struct,
                        java.nio.ByteBuffer value)
        Unsafe version of src.

      • nsize

        public static void nsize​(long struct,
                         long value)
        Sets the specified value to the size field of the specified struct.

      • npos

        public static void npos​(long struct,
                        long value)
        Unsafe version of pos.

      • validate

        public static void validate​(long struct)
        Validates pointer members that should not be NULL.
        Parameters:
        struct - the struct to validate

      • validate

        public static void validate​(long array,
                            int count)
        Calls validate(long) for each struct contained in the specified struct array.
        Parameters:
        array - the struct array to validate
        count - the number of structs in array