Class CXString

All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer

public class CXString extends Struct<CXString> implements NativeResource

 struct CXString {
     void const * data;
     unsigned private_flags;
 }
  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.
    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.
    • DATA

      public static final int DATA
      The struct member offsets.
    • PRIVATE_FLAGS

      public static final int PRIVATE_FLAGS
      The struct member offsets.
  • Constructor Details

    • CXString

      public CXString(ByteBuffer container)
      Creates a CXString 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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<CXString>
    • data

      public ByteBuffer data(int capacity)
      Returns:
      a ByteBuffer view of the data pointed to by the data field.
    • private_flags

      public int private_flags()
      Returns:
      the value of the private_flags field.
    • malloc

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

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

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

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

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

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

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

      public static CXString.Buffer create(int capacity)
      Returns a new CXString.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity
    • create

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

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

      public static CXString malloc(MemoryStack stack)
      Returns a new CXString instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate
    • calloc

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

      public static CXString.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new CXString.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • calloc

      public static CXString.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new CXString.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate
    • ndata

      public static ByteBuffer ndata(long struct, int capacity)
      Unsafe version of data.
    • nprivate_flags

      public static int nprivate_flags(long struct)
      Unsafe version of private_flags().