Class StructLayout

java.lang.Object

jnr.ffi.Type

jnr.ffi.StructLayout

public class StructLayout
extends Type

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	StructLayout.AbstractBoolean	Base class for Boolean fields
protected class	StructLayout.AbstractField	Base implementation of Member
class	StructLayout.AsciiString
class	StructLayout.AsciiStringRef
final class	StructLayout.blkcnt_t
final class	StructLayout.blksize_t
final class	StructLayout.BOOL16
protected final class	StructLayout.Boolean	A normal C boolean - 1 byte in size
final class	StructLayout.caddr_t
final class	StructLayout.clock_t
final class	StructLayout.dev_t
final class	StructLayout.Double
class	StructLayout.Enum<T extends Enum<T>>
class	StructLayout.Enum16<E extends Enum<E>>
class	StructLayout.Enum32<E extends Enum<E>>
class	StructLayout.Enum64<E extends Enum<E>>
class	StructLayout.Enum8<E extends Enum<E>>	An 8 bit enum field.
protected class	StructLayout.EnumField<E extends Enum<E>>	Base for all the Enum fields.
class	StructLayout.EnumLong<E extends Enum<E>>
protected class	StructLayout.Field	Interface all Struct members must implement.
class	StructLayout.Float
final class	StructLayout.fsblkcnt_t
final class	StructLayout.fsfilcnt_t
protected final class	StructLayout.Function<T>
final class	StructLayout.gid_t
final class	StructLayout.id_t
final class	StructLayout.in_addr_t
final class	StructLayout.in_port_t
final class	StructLayout.ino_t
final class	StructLayout.ino64_t
final class	StructLayout.int16_t
final class	StructLayout.int32_t
final class	StructLayout.int64_t
final class	StructLayout.int8_t
class	StructLayout.IntegerAlias
final class	StructLayout.intptr_t
final class	StructLayout.key_t
final class	StructLayout.mode_t
final class	StructLayout.nlink_t
protected class	StructLayout.NumberField	Base class for all Number structure fields.
final class	StructLayout.off_t
protected static final class	StructLayout.Offset
protected final class	StructLayout.Padding	Specialized padding fields for structs.
final class	StructLayout.pid_t
class	StructLayout.Pointer	Represents a native memory address.
final class	StructLayout.rlim_t
final class	StructLayout.sa_family_t
class	StructLayout.Signed16	A 16 bit signed integer field.
class	StructLayout.Signed32	A 32 bit signed integer field.
class	StructLayout.Signed64	A 64 bit signed integer field.
class	StructLayout.Signed8	An 8 bit signed integer
class	StructLayout.SignedLong	A native long integer field.
final class	StructLayout.size_t
final class	StructLayout.socklen_t
final class	StructLayout.ssize_t
class	StructLayout.String
final class	StructLayout.swblk_t
final class	StructLayout.time_t
final class	StructLayout.u_int16_t
final class	StructLayout.u_int32_t
final class	StructLayout.u_int64_t
final class	StructLayout.u_int8_t
final class	StructLayout.uid_t
final class	StructLayout.uintptr_t
class	StructLayout.Unsigned16	A 16 bit signed integer field.
class	StructLayout.Unsigned32	A 32 bit signed integer field.
class	StructLayout.Unsigned64	A 64 bit unsigned integer field.
class	StructLayout.Unsigned8	An 8 bit unsigned integer
class	StructLayout.UnsignedLong	A native long integer field.
class	StructLayout.UTF8String
class	StructLayout.UTF8StringRef
class	StructLayout.UTFString
class	StructLayout.UTFStringRef
protected final class	StructLayout.WBOOL	A Windows BOOL - 4 bytes

Field Summary

Fields

Modifier and Type	Field	Description
(package private) int	alignment
(package private) static final Charset	ASCII
(package private) StructLayout	enclosing
private final boolean	isUnion
(package private) int	offset
(package private) int	paddedSize
private boolean	resetIndex
private final Runtime	runtime
(package private) int	size
(package private) static final Charset	UTF8

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StructLayout(Runtime runtime)	Creates a new StructLayout.
protected	StructLayout(Runtime runtime, int structSize)

Method Summary

Modifier and Type	Method	Description
protected final int	addField(int size, int align)
protected final int	addField(int size, int align, StructLayout.Offset offset)
protected final int	addField(Type t)
protected final int	addField(Type t, StructLayout.Offset offset)
private static int	align(int offset, int alignment)
final int	alignment()	The native alignment of this type, in bytes
protected <T extends StructLayout.Field> T[]	array(T[] array)	Creates an array of Member instances.
protected final void	arrayBegin()	Starts an array construction session
protected final void	arrayEnd()	Ends an array construction session
protected final StructLayout.Offset	at(int offset)
protected final <T> StructLayout.Function<T>	function(Class<T> closureClass)
protected final <T> StructLayout.Function<T>	function(Class<T> closureClass, StructLayout.Offset offset)
NativeType	getNativeType()	The native type of this type
final Runtime	getRuntime()
protected final <T extends StructLayout> T	inner(T structLayout)
final int	offset()
final int	size()	The size in bytes of this type.
String	toString()	Returns a human readable String representation of the structure.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ASCII

static final Charset ASCII

UTF8

static final Charset UTF8

runtime

private final Runtime runtime

isUnion

private final boolean isUnion

See Also:

• Constant Field Values

resetIndex

private boolean resetIndex

enclosing

StructLayout enclosing

offset

int offset

size

int size

alignment

int alignment

paddedSize

int paddedSize

Constructor Details

StructLayout

protected StructLayout(Runtime runtime)

Creates a new StructLayout.

Parameters:

runtime - The current runtime.

StructLayout

protected StructLayout(Runtime runtime,
 int structSize)

Method Details

getRuntime

public final Runtime getRuntime()

size

public final int size()

Description copied from class: Type

The size in bytes of this type.

Specified by:

size in class Type

Returns:

An integer

alignment

public final int alignment()

Description copied from class: Type

The native alignment of this type, in bytes

Specified by:

alignment in class Type

Returns:

An integer

offset

public final int offset()

getNativeType

public NativeType getNativeType()

Description copied from class: Type

The native type of this type

Specified by:

getNativeType in class Type

Returns:

the native type of this type

toString

public String toString()

Returns a human readable String representation of the structure.

Overrides:

toString in class Object

Returns:

a String representation of this structure.

align

private static int align(int offset,
 int alignment)

addField

protected final int addField(int size,
 int align)

addField

protected final int addField(int size,
 int align,
 StructLayout.Offset offset)

addField

protected final int addField(Type t)

addField

protected final int addField(Type t,
 StructLayout.Offset offset)

at

protected final StructLayout.Offset at(int offset)

arrayBegin

protected final void arrayBegin()

Starts an array construction session

arrayEnd

protected final void arrayEnd()

Ends an array construction session

array

protected <T extends StructLayout.Field> T[] array(T[] array)

Creates an array of Member instances.

Type Parameters:

T - The type of the Member subclass to create.

Parameters:

array - the array to store the instances in

Returns:

the array that was passed in

inner

protected final <T extends StructLayout> T inner(T structLayout)

function

protected final <T> StructLayout.Function<T> function(Class<T> closureClass)

function

protected final <T> StructLayout.Function<T> function(Class<T> closureClass,
 StructLayout.Offset offset)