Package org.jruby.ext.ffi

Class StructLayout.Field

java.lang.Object

org.jruby.RubyBasicObject

org.jruby.RubyObject

org.jruby.ext.ffi.StructLayout.Field

All Implemented Interfaces:

Serializable, Cloneable, Comparable<IRubyObject>, InstanceVariables, InternalVariables, IRubyObject, CoreObjectType

Direct Known Subclasses:

StructLayout.ArrayField, StructLayout.EnumField, StructLayout.FunctionField, StructLayout.InnerStructField, StructLayout.NumberField, StructLayout.PointerField, StructLayout.StringField

Enclosing class:

StructLayout

public static class StructLayout.Field
extends RubyObject

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.RubyObject

RubyObject.Data

Nested classes/interfaces inherited from class org.jruby.RubyBasicObject

RubyBasicObject.Finalizer

Field Summary

Fields

Modifier and Type	Field	Description
private StructLayout.FieldIO	io	The basic ops to read/write this field
private MemoryOp	memoryOp	The memory operation for this field type
private IRubyObject	name	The name of this field
private int	offset	The offset within the memory area of this member
private Type	type	The Type of this field.

Fields inherited from class org.jruby.RubyObject

IVAR_INSPECTING_OBJECT_ALLOCATOR, OBJECT_ALLOCATOR, REIFYING_OBJECT_ALLOCATOR

Fields inherited from class org.jruby.RubyBasicObject

ALL_F, BASICOBJECT_ALLOCATOR, COMPARE_BY_IDENTITY_F, ERR_INSECURE_SET_INST_VAR, FALSE_F, FL_USHIFT, flags, FROZEN_F, IS_OVERLAID_F, metaClass, NEVER, NIL_F, REFINED_MODULE_F, STAMP_OFFSET, TAINTED_F, UNDEF, UNTRUST_F, USER0_F, USER1_F, USER2_F, USER3_F, USER4_F, USER5_F, USER6_F, USER7_F, USER8_F, USER9_F, USERA_F, VAR_TABLE_OFFSET, varTable, varTableStamp

Fields inherited from interface org.jruby.runtime.builtin.IRubyObject

NULL_ARRAY

Constructor Summary

Constructors

Constructor	Description
Field(Ruby runtime, RubyClass klass)
Field(Ruby runtime, RubyClass klass, StructLayout.FieldIO io)
Field(Ruby runtime, RubyClass klass, Type type, int offset, StructLayout.FieldIO io)

Method Summary

Modifier and Type	Method	Description
final IRubyObject	alignment(ThreadContext context)
(package private) final Type	checkType(IRubyObject type)
boolean	equals(Object obj)	This override does not do a "checked" dispatch.
final Type	ffiType()
final IRubyObject	get(ThreadContext context, IRubyObject pointer)
(package private) static ByteOrder	getByteOrderOption(ThreadContext context, IRubyObject[] args)
(package private) final StructLayout.FieldIO	getFieldIO()
int	hashCode()	This override does not do "checked" dispatch since Object usually has #hash defined.
(package private) void	init(IRubyObject[] args, StructLayout.FieldIO io)
(package private) void	init(IRubyObject name, IRubyObject type, IRubyObject offset)
(package private) void	init(IRubyObject name, IRubyObject type, IRubyObject offset, StructLayout.FieldIO io)
IRubyObject	initialize(ThreadContext context, IRubyObject[] args)
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
final IRubyObject	name(ThreadContext context)
final int	offset()
final IRubyObject	offset(ThreadContext context)
final IRubyObject	put(ThreadContext context, IRubyObject pointer, IRubyObject value)
final IRubyObject	size(ThreadContext context)
final IRubyObject	type(ThreadContext context)

Methods inherited from class org.jruby.RubyObject

attachToObjectSpace, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, callInit, convertToType, createObjectClass, dig, dig1, dig2, eqlInternal, equalInternal, getNativeClassIndex, inspect, op_eqq, puts, specificEval, toRubyString, toString

Methods inherited from class org.jruby.RubyBasicObject

addFinalizer, anyToString, asJavaString, asString, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callMethod, callSuper, checkArrayType, checkCallMethod, checkCallMethod, checkFrozen, checkStringType, checkStringType19, compareTo, convertToArray, convertToFloat, convertToHash, convertToInteger, convertToInteger, convertToInteger, convertToString, copyInstanceVariablesInto, copySpecialInstanceVariables, createBasicObjectClass, dataGetStruct, dataGetStructChecked, dataWrapStruct, decode, display, dup, ensureInstanceVariablesSettable, eql, eql_p, equal_p, equal_p19, evalUnder, extend, fastGetInstanceVariable, fastGetInternalVariable, fastHasInstanceVariable, fastHasInternalVariable, fastSetInstanceVariable, fastSetInternalVariable, freeze, frozen_p, getFFIHandle, getFlag, getInstanceEvalClass, getInstanceVariable, getInstanceVariableList, getInstanceVariableNameList, getInstanceVariables, getInternalVariable, getInternalVariables, getJavaClass, getMetaClass, getMetaClass, getNativeHandle, getNativeTypeIndex, getObjectId, getRuntime, getSingletonClass, getSingletonClassClone, getSingletonClassCloneAndAttach, getType, getVariable, getVariableCount, getVariableList, getVariableNameList, hash, hashyInspect, hasInstanceVariable, hasInstanceVariables, hasInternalVariable, hasVariables, id, infectBy, initialize, initialize_copy, initialize19, inspect, inspectHashCode, instance_eval, instance_eval, instance_eval, instance_eval, instance_eval19, instance_eval19, instance_eval19, instance_eval19, instance_exec, instance_exec19, instance_of_p, instance_variable_defined_p, instance_variable_get, instance_variable_set, instance_variables, instance_variables19, isBuiltin, isClass, isFalse, isFrozen, isImmediate, isModule, isNil, isSpecialConst, isSpecialObject, isTaint, isTrue, isUntrusted, kind_of_p, makeMetaClass, method, method_missing, method_missing19, method19, methods, methods, methods19, nil_p, nonFixnumHashCode, OBJ_INIT_COPY, objInitCopy, op_cmp, op_equal, op_equal_19, op_match, op_match19, op_not, op_not_equal, op_not_match, private_methods, private_methods19, protected_methods, protected_methods19, public_methods, public_methods19, rbClone, rbClone, rbInspect, remove_instance_variable, removeFinalizers, removeInstanceVariable, removeInternalVariable, respond_to_p, respond_to_p, respond_to_p19, respond_to_p19, respondsTo, respondsToMissing, respondsToMissing, send, send, send, send, send, send19, send19, send19, send19, setFFIHandle, setFlag, setFrozen, setInstanceVariable, setInternalVariable, setMetaClass, setNativeHandle, setTaint, setUntrusted, setVariable, singleton_method, singleton_method_added, singleton_method_added19, singleton_method_removed, singleton_method_removed19, singleton_method_undefined, singleton_method_undefined19, singleton_methods, specificEval, specificEval, specificEval, specificEval, syncVariables, syncVariables, taint, taint, tainted_p, testFrozen, testFrozen, to_a, to_a, to_s, toJava, trust, type, type_deprecated, untaint, untrust, untrusted_p, validateInstanceVariable, validateInstanceVariable, validateInstanceVariable, variableTableContains, variableTableFastContains, variableTableFastFetch, variableTableFastStore, variableTableFetch, variableTableRemove, variableTableStore, variableTableSync, yieldUnder, yieldUnder

Methods inherited from class java.lang.Object

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

Field Details

io

private StructLayout.FieldIO io

The basic ops to read/write this field

name

private IRubyObject name

The name of this field

type

private Type type

The Type of this field.

offset

private int offset

The offset within the memory area of this member

memoryOp

private MemoryOp memoryOp

The memory operation for this field type

Constructor Details

Field

Field(Ruby runtime,
 RubyClass klass)

Field

Field(Ruby runtime,
 RubyClass klass,
 StructLayout.FieldIO io)

Field

Field(Ruby runtime,
 RubyClass klass,
 Type type,
 int offset,
 StructLayout.FieldIO io)

Method Details

init

void init(IRubyObject name,
 IRubyObject type,
 IRubyObject offset)

init

void init(IRubyObject name,
 IRubyObject type,
 IRubyObject offset,
 StructLayout.FieldIO io)

init

void init(IRubyObject[] args,
 StructLayout.FieldIO io)

initialize

public IRubyObject initialize(ThreadContext context,
 IRubyObject[] args)

checkType

final Type checkType(IRubyObject type)

offset

public final int offset()

ffiType

public final Type ffiType()

equals

public boolean equals(Object obj)

Description copied from class: RubyObject

This override does not do a "checked" dispatch.

Overrides:

equals in class RubyObject

See Also:

• RubyBasicObject.equals(Object)

hashCode

public int hashCode()

Description copied from class: RubyObject

This override does not do "checked" dispatch since Object usually has #hash defined.

Overrides:

hashCode in class RubyObject

See Also:

• RubyBasicObject.hashCode()

isCacheable

public final boolean isCacheable()

Gets the cacheable status of this Struct member

Returns:

true if this member type is cacheable

isValueReferenceNeeded

public final boolean isValueReferenceNeeded()

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

Returns:

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

getFieldIO

final StructLayout.FieldIO getFieldIO()

getByteOrderOption

static ByteOrder getByteOrderOption(ThreadContext context,
 IRubyObject[] args)

size

public final IRubyObject size(ThreadContext context)

alignment

public final IRubyObject alignment(ThreadContext context)

offset

public final IRubyObject offset(ThreadContext context)

type

public final IRubyObject type(ThreadContext context)

name

public final IRubyObject name(ThreadContext context)

get

public final IRubyObject get(ThreadContext context,
 IRubyObject pointer)

put

public final IRubyObject put(ThreadContext context,
 IRubyObject pointer,
 IRubyObject value)