Class ZSTDCustomMem

    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • CUSTOMALLOC, CUSTOMFREE, OPAQUE

        The struct member offsets.
    • Constructor Detail

      • ZSTDCustomMem

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

        public ZSTDAllocFunction customAlloc()
        Returns the value of the customAlloc field.
      • customFree

        public ZSTDFreeFunction customFree()
        Returns the value of the customFree field.
      • opaque

        public long opaque()
        Returns the value of the opaque field.
      • opaque

        public ZSTDCustomMem opaque​(long value)
        Sets the specified value to the opaque field.
      • set

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

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

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

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

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

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

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

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

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

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

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

        public static long nopaque​(long struct)
        Unsafe version of opaque().
      • nopaque

        public static void nopaque​(long struct,
                                   long value)
        Unsafe version of opaque.
      • 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