Class Tuples

All Implemented Interfaces:
Proxy

@Generated("org.javagi.JavaGI") @Deprecated public class Tuples extends ProxyInstance
Deprecated.
Rarely used API
The GTuples struct is used to return records (or tuples) from the GRelation by g_relation_select(). It only contains one public member - the number of records that matched. To access the matched records, you must use g_tuples_index().
  • Constructor Summary

    Constructors
    Constructor
    Description
    Deprecated.
    Allocate a new Tuples.
    Tuples(int len)
    Deprecated.
    Allocate a new Tuples with the fields set to the provided values.
    Tuples(int len, Arena arena)
    Deprecated.
    Allocate a new Tuples with the fields set to the provided values.
    Tuples(Arena arena)
    Deprecated.
    Allocate a new Tuples.
    Deprecated.
    Create a Tuples proxy instance for the provided memory address.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Deprecated.
    Rarely used API
    Deprecated.
    The memory layout of the native struct.
    @Nullable MemorySegment
    index(int index, int field)
    Deprecated.
    Rarely used API
    int
    Deprecated.
    Read the value of the field len.
    void
    writeLen(int len)
    Deprecated.
    Write a value in the field len.

    Methods inherited from class ProxyInstance

    equals, handle, hashCode

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • Tuples

      public Tuples(MemorySegment address)
      Deprecated.
      Create a Tuples proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object
    • Tuples

      public Tuples(Arena arena)
      Deprecated.
      Allocate a new Tuples.
      Parameters:
      arena - to control the memory allocation scope
    • Tuples

      public Tuples()
      Deprecated.
      Allocate a new Tuples. The memory is allocated with Arena.ofAuto().
    • Tuples

      public Tuples(int len, Arena arena)
      Deprecated.
      Allocate a new Tuples with the fields set to the provided values.
      Parameters:
      len - value for the field len
      arena - to control the memory allocation scope
    • Tuples

      public Tuples(int len)
      Deprecated.
      Allocate a new Tuples with the fields set to the provided values. The memory is allocated with Arena.ofAuto().
      Parameters:
      len - value for the field len
  • Method Details

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      Deprecated.
      The memory layout of the native struct.
      Returns:
      the memory layout
    • readLen

      public int readLen()
      Deprecated.
      Read the value of the field len.
      Returns:
      The value of the field len
    • writeLen

      public void writeLen(int len)
      Deprecated.
      Write a value in the field len.
      Parameters:
      len - The new value for the field len
    • destroy

      @Deprecated public void destroy()
      Deprecated.
      Rarely used API
      Frees the records which were returned by g_relation_select(). This should always be called after g_relation_select() when you are finished with the records. The records are not removed from the GRelation.
    • index

      @Deprecated public @Nullable MemorySegment index(int index, int field)
      Deprecated.
      Rarely used API
      Gets a field from the records returned by g_relation_select(). It returns the given field of the record at the given index. The returned value should not be changed.
      Parameters:
      index - the index of the record.
      field - the field to return.
      Returns:
      the field of the record.