Package org.jruby.ext.ffi

Class StructLayout.EnumFieldIO

java.lang.Object

org.jruby.ext.ffi.StructLayout.EnumFieldIO

All Implemented Interfaces:

StructLayout.FieldIO

Enclosing class:

StructLayout

static final class StructLayout.EnumFieldIO
extends Object
implements StructLayout.FieldIO

Enum (maps :foo => 1, :bar => 2, etc)

Field Summary

Fields

Modifier and Type	Field	Description
private final MemoryOp	op

Constructor Summary

Constructors

Constructor	Description
EnumFieldIO(ByteOrder order)

Method Summary

Modifier and Type	Method	Description
IRubyObject	get(ThreadContext context, StructLayout.Storage cache, StructLayout.Member m, AbstractMemory ptr)	Reads a ruby value from the struct member.
final boolean	isCacheable()	Gets the cacheable status of this Struct member
final boolean	isValueReferenceNeeded()	Checks if a reference to the ruby object assigned to this field needs to be stored
void	put(ThreadContext context, StructLayout.Storage cache, StructLayout.Member m, AbstractMemory ptr, IRubyObject value)	Writes a ruby value to the native struct member as the appropriate native value.

Methods inherited from class java.lang.Object

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

Field Details

op

private final MemoryOp op

Constructor Details

EnumFieldIO

public EnumFieldIO(ByteOrder order)

Method Details

put

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

Description copied from interface: StructLayout.FieldIO

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

Specified by:

put in interface StructLayout.FieldIO

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 IRubyObject get(ThreadContext context,
 StructLayout.Storage cache,
 StructLayout.Member m,
 AbstractMemory ptr)

Description copied from interface: StructLayout.FieldIO

Reads a ruby value from the struct member.

Specified by:

get in interface StructLayout.FieldIO

cache - The cache used to store

ptr - The struct memory area.

Returns:

A ruby object equivalent to the native member value.

isCacheable

public final boolean isCacheable()

Description copied from interface: StructLayout.FieldIO

Gets the cacheable status of this Struct member

Specified by:

isCacheable in interface StructLayout.FieldIO

Returns:

true if this member type is cacheable

isValueReferenceNeeded

public final boolean isValueReferenceNeeded()

Description copied from interface: StructLayout.FieldIO

Checks if a reference to the ruby object assigned to this field needs to be stored

Specified by:

isValueReferenceNeeded in interface StructLayout.FieldIO

Returns:

true if this member type requires the ruby value to be stored.