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 java.lang.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 and Description
(package private) int	cacheIndex The index of this member within the struct field cache
(package private) StructLayout.Field	field
(package private) int	index The index of this member within the struct
(package private) StructLayout.FieldIO	io
(package private) IRubyObject	name
(package private) int	offset The offset within the memory area of this member
(package private) int	referenceIndex The index of this member within the struct field reference array
(package private) Type	type The Type of this member.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
IRubyObject	get(ThreadContext context, StructLayout.Storage cache, AbstractMemory ptr) Reads a ruby value from the struct member.
(package private) int	getIndex()
(package private) long	getOffset(IRubyObject ptr)
int	hashCode()
int	offset()
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.
Type	type()

Methods inherited from class java.lang.Object

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

Field Detail

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 Detail

Member

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

Initializes a new Member instance

Method Detail

getOffset

final long getOffset(IRubyObject ptr)

getIndex

final int getIndex()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.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:

runtime - The ruby runtime

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()