Package org.jruby.ext.ffi

Class StructLayout.Member

java.lang.Object

org.jruby.ext.ffi.StructLayout.Member

Enclosing class:

StructLayout

public static final class StructLayout.Member
extends Object

A struct member. This defines the offset within a chunk of memory to use when reading/writing the member, as well as how to convert between the native representation of the member and the JRuby representation.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final int	cacheIndex	The index of this member within the struct field cache
(package private) final StructLayout.Field	field
(package private) final int	index	The index of this member within the struct
(package private) final StructLayout.FieldIO	io
(package private) final IRubyObject	name
(package private) final int	offset	The offset within the memory area of this member
(package private) final int	referenceIndex	The index of this member within the struct field reference array
(package private) final Type	type	The Type of this member.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Member(StructLayout.Field f, int index, int cacheIndex, int referenceIndex)	Initializes a new Member instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
final IRubyObject	get(ThreadContext context, StructLayout.Storage cache, AbstractMemory ptr)	Reads a ruby value from the struct member.
(package private) final int	getIndex()
(package private) final long	getOffset(IRubyObject ptr)
int	hashCode()
final int	offset()
final void	put(ThreadContext context, StructLayout.Storage cache, AbstractMemory ptr, IRubyObject value)	Writes a ruby value to the native struct member as the appropriate native value.
final Type	type()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

io

final StructLayout.FieldIO io

field

final StructLayout.Field field

type

final Type type

The Type of this member.

offset

final int offset

The offset within the memory area of this member

cacheIndex

final int cacheIndex

The index of this member within the struct field cache

referenceIndex

final int referenceIndex

The index of this member within the struct field reference array

index

final int index

The index of this member within the struct

name

final IRubyObject name

Constructor Details

Member

protected Member(StructLayout.Field f,
 int index,
 int cacheIndex,
 int referenceIndex)

Initializes a new Member instance

Method Details

getOffset

final long getOffset(IRubyObject ptr)

getIndex

final int getIndex()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

put

public final void put(ThreadContext context,
 StructLayout.Storage cache,
 AbstractMemory ptr,
 IRubyObject value)

Writes a ruby value to the native struct member as the appropriate native value.

Parameters:

context - the current context

cache - The value cache

ptr - The struct memory area.

value - The ruby value to write to the native struct member.

get

public final IRubyObject get(ThreadContext context,
 StructLayout.Storage cache,
 AbstractMemory ptr)

Reads a ruby value from the struct member.

Parameters:

cache - The cache used to store

ptr - The struct memory area.

Returns:

A ruby object equivalent to the native member value.

offset

public final int offset()

type

public final Type type()