Struct.StructRef (jnr-ffi 2.2.13 API)

java.lang.Object
- jnr.ffi.Struct.Member
- - jnr.ffi.Struct.NumberField
  - - jnr.ffi.Struct.PointerField
    - - jnr.ffi.Struct.StructRef<T>

Type Parameters:

T - - Struct type

Enclosing class:

Struct
```
public class Struct.StructRef<T extends Struct>
extends Struct.PointerField
```
Represents a reference to a Struct or and array of Structs

Field Summary
- Fields inherited from class jnr.ffi.Struct.NumberField
  type

Constructor Summary

Constructors
Constructor	Description
`StructRef(Class<T> structType)`
`StructRef(Class<T> structType, int initialStructCount)`
`StructRef(Struct.Offset offset, Class<T> structType)`
`StructRef(Struct.Offset offset, Class<T> structType, int initialStructCount)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`get()`
`T[]`	`get(int length)`
`void`	`set(T struct)`
`void`	`set(T[] structs)`
`String`	`toString()`	Returns a string representation of this `Pointer`.

Methods inherited from class jnr.ffi.Struct.PointerField
getPointer, intValue, longValue, set, set, size

Methods inherited from class jnr.ffi.Struct.NumberField
byteValue, doubleValue, floatValue, getMemory, offset, shortValue, struct

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StructRef
```
public StructRef(Class<T> structType)
```
  - StructRef
```
public StructRef(Class<T> structType,
                 int initialStructCount)
```
    Parameters:
    
    structType - Struct type
    
    initialStructCount - the number of struct instances. Use this to allocate memory without setting value.
  - StructRef
```
public StructRef(Struct.Offset offset,
                 Class<T> structType)
```
  - StructRef
```
public StructRef(Struct.Offset offset,
                 Class<T> structType,
                 int initialStructCount)
```
    Parameters:
    
    offset - offset of the field
    
    structType - Struct type
    
    initialStructCount - the number of struct instances. Use this to allocate memory without setting value.
- Method Detail
  - set
```
public final void set(T struct)
```
  - set
```
public final void set(T[] structs)
```
  - get
```
public final T get()
```
    Returns:
    
    struct from memory
  - get
```
public final T[] get(int length)
```
    Parameters:
    
    length - the length of struct in memory to get
    
    Returns:
    
    struct from memory
  - toString
```
public String toString()
```
    Description copied from class: Struct.PointerField
    
    Returns a string representation of this Pointer.
    
    Overrides:
    
    toString in class Struct.PointerField
    
    Returns:
    
    a string representation of this Pointer.