Class ZSTDInBuffer

  • All Implemented Interfaces:
    java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

    public class ZSTDInBuffer
    extends org.lwjgl.system.Struct
    implements org.lwjgl.system.NativeResource

    Member documentation

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

    Layout

    
     struct ZSTD_inBuffer {
         void const * src;
         size_t size;
         size_t pos;
     }
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ZSTDInBuffer.Buffer
      An array of ZSTDInBuffer structs.
      • Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

        org.lwjgl.system.Pointer.Default
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALIGNOF
      The struct alignment in bytes.
      static int POS
      SIZE
      The struct member offsets.
      static int SIZEOF
      The struct size in bytes.
      static int SRC
      The struct member offsets.
      • Fields inherited from interface org.lwjgl.system.Pointer

        BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
    • Constructor Summary

      Constructors 
      Constructor Description
      ZSTDInBuffer​(java.nio.ByteBuffer container)
      Creates a ZSTDInBuffer instance at the current position of the specified ByteBuffer container.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ZSTDInBuffer calloc()
      Returns a new ZSTDInBuffer instance allocated with memCalloc.
      static ZSTDInBuffer.Buffer calloc​(int capacity)
      Returns a new ZSTDInBuffer.Buffer instance allocated with memCalloc.
      static ZSTDInBuffer callocStack()
      Returns a new ZSTDInBuffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
      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.
      static ZSTDInBuffer.Buffer callocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new ZSTDInBuffer.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static ZSTDInBuffer callocStack​(org.lwjgl.system.MemoryStack stack)
      Returns a new ZSTDInBuffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      static ZSTDInBuffer create()
      Returns a new ZSTDInBuffer instance allocated with BufferUtils.
      static ZSTDInBuffer.Buffer create​(int capacity)
      Returns a new ZSTDInBuffer.Buffer instance allocated with BufferUtils.
      static ZSTDInBuffer create​(long address)
      Returns a new ZSTDInBuffer instance for the specified memory address.
      static ZSTDInBuffer.Buffer create​(long address, int capacity)
      Create a ZSTDInBuffer.Buffer instance at the specified memory.
      static ZSTDInBuffer createSafe​(long address)
      Like create, but returns null if address is NULL.
      static ZSTDInBuffer.Buffer createSafe​(long address, int capacity)
      Like create, but returns null if address is NULL.
      static ZSTDInBuffer malloc()
      Returns a new ZSTDInBuffer instance allocated with memAlloc.
      static ZSTDInBuffer.Buffer malloc​(int capacity)
      Returns a new ZSTDInBuffer.Buffer instance allocated with memAlloc.
      static ZSTDInBuffer mallocStack()
      Returns a new ZSTDInBuffer instance allocated on the thread-local MemoryStack.
      static ZSTDInBuffer.Buffer mallocStack​(int capacity)
      Returns a new ZSTDInBuffer.Buffer instance allocated on the thread-local MemoryStack.
      static ZSTDInBuffer.Buffer mallocStack​(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new ZSTDInBuffer.Buffer instance allocated on the specified MemoryStack.
      static ZSTDInBuffer mallocStack​(org.lwjgl.system.MemoryStack stack)
      Returns a new ZSTDInBuffer instance allocated on the specified MemoryStack.
      static long npos​(long struct)
      Unsafe version of pos().
      static void npos​(long struct, long value)
      Unsafe version of pos.
      static long nsize​(long struct)
      Unsafe version of size().
      static void nsize​(long struct, long value)
      Sets the specified value to the size field of the specified struct.
      static java.nio.ByteBuffer nsrc​(long struct)
      Unsafe version of src.
      static void nsrc​(long struct, java.nio.ByteBuffer value)
      Unsafe version of src.
      long pos()
      Returns the value of the pos field.
      ZSTDInBuffer pos​(long value)
      Sets the specified value to the pos field.
      ZSTDInBuffer set​(java.nio.ByteBuffer src, long pos)
      Initializes this struct with the specified values.
      ZSTDInBuffer set​(ZSTDInBuffer src)
      Copies the specified struct data to this struct.
      long size()
      Returns the value of the size field.
      int sizeof()  
      java.nio.ByteBuffer src()
      Returns a ByteBuffer view of the data pointed to by the src field.
      ZSTDInBuffer src​(java.nio.ByteBuffer value)
      Sets the address of the specified ByteBuffer to the src field.
      static void validate​(long struct)
      Validates pointer members that should not be NULL.
      static void validate​(long array, int count)
      Calls validate(long) for each struct contained in the specified struct array.
      • Methods inherited from interface org.lwjgl.system.NativeResource

        close, free
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from class org.lwjgl.system.Pointer.Default

        address, equals, hashCode, toString
      • Methods inherited from class org.lwjgl.system.Struct

        clear, free, isNull
    • 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()
        Specified by:
        sizeof in class org.lwjgl.system.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()
        Returns a new ZSTDInBuffer instance allocated with BufferUtils.
      • 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.
      • malloc

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

        public static ZSTDInBuffer.Buffer calloc​(int capacity)
        Returns a new ZSTDInBuffer.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
        Parameters:
        capacity - the buffer capacity
      • 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​(org.lwjgl.system.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​(org.lwjgl.system.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
      • mallocStack

        public static ZSTDInBuffer.Buffer mallocStack​(int capacity)
        Returns a new ZSTDInBuffer.Buffer instance allocated on the thread-local MemoryStack.
        Parameters:
        capacity - the buffer capacity
      • 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
      • mallocStack

        public static ZSTDInBuffer.Buffer mallocStack​(int capacity,
                                                      org.lwjgl.system.MemoryStack stack)
        Returns a new ZSTDInBuffer.Buffer instance allocated on the specified MemoryStack.
        Parameters:
        stack - the stack from which to allocate
        capacity - the buffer capacity
      • callocStack

        public static ZSTDInBuffer.Buffer callocStack​(int capacity,
                                                      org.lwjgl.system.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