Class ZSTDOutBuffer

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

    public class ZSTDOutBuffer
    extends Struct
    implements NativeResource

    Member documentation

    • dst – start of output buffer
    • size – size of output buffer
    • pos – position where writing stopped. Will be updated. Necessarily 0 <= pos <= size

    Layout

    
     struct ZSTD_outBuffer {
         void * dst;
         size_t size;
         size_t pos;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • DST, SIZE, POS

        The struct member offsets.
    • Constructor Detail

      • ZSTDOutBuffer

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

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

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

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

        public ZSTDOutBuffer dst​(java.nio.ByteBuffer value)
        Sets the address of the specified ByteBuffer to the dst field.
      • pos

        public ZSTDOutBuffer pos​(long value)
        Sets the specified value to the pos field.
      • set

        public ZSTDOutBuffer set​(java.nio.ByteBuffer dst,
                                 long pos)
        Initializes this struct with the specified values.
      • set

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

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

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

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

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

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

        public static java.nio.ByteBuffer ndst​(long struct)
        Unsafe version of dst.
      • nsize

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

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

        public static void ndst​(long struct,
                                java.nio.ByteBuffer value)
        Unsafe version of dst.
      • 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