JRuby Base 10.0.0.0 · org.jruby.ext.ffi.Struct · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
private StructLayout	layout
private AbstractMemory	memory Hides org.jruby.ext.ffi.MemoryObject.memory.
private volatile Object[]	referenceCache
private static final AtomicReferenceFieldUpdater<Struct, Object[]>	referenceCacheUpdater
private volatile IRubyObject[]	valueCache
private static final AtomicReferenceFieldUpdater<Struct, IRubyObject[]>	valueCacheUpdater

Constructor Summary

Access	Constructor and Description
pack-priv	Struct(Ruby The runtime for the `StructLayout` runtime) Creates a new `StructLayout` instance using defaults.
public	Struct(Ruby The runtime for the `StructLayout` runtime, RubyClass the ruby class to use for the `StructLayout` klass) Creates a new `StructLayout` instance.
pack-priv	Struct(Ruby The runtime for the `StructLayout` runtime, RubyClass the ruby class to use for the `StructLayout` klass, StructLayout layout, IRubyObject memory) Creates a new `StructLayout` instance.

Method Summary

Modifier and Type	Method and Description
public static IRubyObject	alignment(ThreadContext context, IRubyObject structClass)
public IRubyObject	alignment(ThreadContext context)
public static IRubyObject	allocateIn(ThreadContext context, IRubyObject klass)
public static IRubyObject	allocateIn(ThreadContext context, IRubyObject klass, IRubyObject clearArg)
public static IRubyObject	allocateInOut(ThreadContext context, IRubyObject klass)
public static IRubyObject	allocateInOut(ThreadContext context, IRubyObject klass, IRubyObject clearArg)
protected final MemoryIO	allocateMemoryIO() Implements abstract org.jruby.ext.ffi.MemoryObject.allocateMemoryIO.
public static IRubyObject	allocateOut(ThreadContext context, IRubyObject klass)
public static IRubyObject	allocateOut(ThreadContext context, IRubyObject klass, IRubyObject clearArg)
private static final Struct	allocateStruct(ThreadContext context, IRubyObject klass, int flags)
public IRubyObject	clear(ThreadContext context)
public static RubyClass	Returns: The new class createStructClass(ThreadContext the current thread context context, RubyModule reference to FFI module FFI) Registers the StructLayout class in the JRuby runtime.
public final IRubyObject	getCachedValue(StructLayout.Member member) Implements org.jruby.ext.ffi.StructLayout.Storage.getCachedValue.
public IRubyObject	getFieldValue(ThreadContext context, IRubyObject fieldName)
public IRubyObject	getLayout(ThreadContext context)
public final AbstractMemory	getMemory()
private Object[]	getReferenceCache()
pack-priv static final StructLayout	getStructLayout(ThreadContext context, IRubyObject structClass)
pack-priv static final int	getStructSize(ThreadContext context, IRubyObject structClass)
private IRubyObject[]	getValueCacheForWrite()
public IRubyObject	initialize(ThreadContext context) Overrides org.jruby.RubyBasicObject.initialize.
public IRubyObject	initialize(ThreadContext context, IRubyObject ptr)
public IRubyObject	initialize(ThreadContext context, IRubyObject[] args)
public IRubyObject	initialize_copy(ThreadContext the thread context context, IRubyObject the original other) Overrides org.jruby.RubyBasicObject.initialize_copy. Initializes this object as a copy of the original, that is the parameter to this object.
private Object[]	initReferenceCache()
private IRubyObject[]	initValueCache()
pack-priv static final boolean	isStruct(ThreadContext context, RubyClass klass)
public static IRubyObject	members(ThreadContext context, IRubyObject structClass)
public IRubyObject	members(ThreadContext context)
public IRubyObject	null_p(ThreadContext context)
public static IRubyObject	offset_of(ThreadContext context, IRubyObject structClass, IRubyObject fieldName)
public IRubyObject	offset_of(ThreadContext context, IRubyObject fieldName)
public static IRubyObject	offsets(ThreadContext context, IRubyObject structClass)
public IRubyObject	offsets(ThreadContext context)
public final IRubyObject	order(ThreadContext context)
public final IRubyObject	order(ThreadContext context, IRubyObject byte_order)
public IRubyObject	pointer(ThreadContext context)
public final void	putCachedValue(StructLayout.Member member, IRubyObject value) Implements org.jruby.ext.ffi.StructLayout.Storage.putCachedValue.
public void	putReference(StructLayout.Member member, Object value) Implements org.jruby.ext.ffi.StructLayout.Storage.putReference.
public static IRubyObject	set_layout(ThreadContext context, IRubyObject structClass, IRubyObject layout)
public IRubyObject	setFieldValue(ThreadContext context, IRubyObject fieldName, IRubyObject fieldValue)
public static IRubyObject	size(ThreadContext context, IRubyObject structClass)
public IRubyObject	size(ThreadContext context)
public IRubyObject	values(ThreadContext context)

Inherited from org.jruby.ext.ffi.MemoryObject:: getMemoryIO setMemoryIO

Field Detail

layout	back to summary
private StructLayout layout

layout

back to summary

private StructLayout layout

memory	back to summary
private AbstractMemory memory Hides org.jruby.ext.ffi.MemoryObject.memory.

referenceCache	back to summary
private volatile Object[] referenceCache

referenceCacheUpdater	back to summary
private static final AtomicReferenceFieldUpdater<Struct, Object[]> referenceCacheUpdater

valueCache	back to summary
private volatile IRubyObject[] valueCache

valueCacheUpdater	back to summary
private static final AtomicReferenceFieldUpdater<Struct, IRubyObject[]> valueCacheUpdater

Constructor Detail

Struct back to summary

Struct	back to summary
pack-priv Struct(Ruby runtime) Creates a new `StructLayout` instance using defaults. Parameters runtime:Ruby The runtime for the `StructLayout`

pack-priv Struct(Ruby runtime)

Creates a new StructLayout instance using defaults.

Parameters

runtime:Ruby: The runtime for the StructLayout

Struct back to summary

Struct	back to summary
public Struct(Ruby runtime, RubyClass klass) Creates a new `StructLayout` instance. Parameters runtime:Ruby The runtime for the `StructLayout` klass:RubyClass the ruby class to use for the `StructLayout`

public Struct(Ruby runtime, RubyClass klass)

Creates a new StructLayout instance.

Parameters

runtime:Ruby: The runtime for the StructLayout
klass:RubyClass: the ruby class to use for the StructLayout

Struct back to summary

Struct	back to summary
pack-priv Struct(Ruby runtime, RubyClass klass, StructLayout layout, IRubyObject memory) Creates a new `StructLayout` instance. Parameters runtime:Ruby The runtime for the `StructLayout` klass:RubyClass the ruby class to use for the `StructLayout`

pack-priv Struct(Ruby runtime, RubyClass klass, StructLayout layout, IRubyObject memory)

Creates a new StructLayout instance.

Parameters

runtime:Ruby: The runtime for the StructLayout
klass:RubyClass: the ruby class to use for the StructLayout

Method Detail

alignment	back to summary
public static IRubyObject alignment(ThreadContext context, IRubyObject structClass) Annotations @JRubyMethod name:alignment meta:true

alignment	back to summary
public IRubyObject alignment(ThreadContext context) Annotations @JRubyMethod name:alignment

allocateIn	back to summary
public static IRubyObject allocateIn(ThreadContext context, IRubyObject klass) Annotations @JRubyMethod name:new_in, alloc_in meta:true

allocateIn	back to summary
public static IRubyObject allocateIn(ThreadContext context, IRubyObject klass, IRubyObject clearArg) Annotations @JRubyMethod name:new_in, alloc_in meta:true

allocateInOut	back to summary
public static IRubyObject allocateInOut(ThreadContext context, IRubyObject klass) Annotations @JRubyMethod name:new_inout, alloc_inout meta:true

allocateInOut	back to summary
public static IRubyObject allocateInOut(ThreadContext context, IRubyObject klass, IRubyObject clearArg) Annotations @JRubyMethod name:new_inout, alloc_inout meta:true

allocateMemoryIO	back to summary
protected final MemoryIO allocateMemoryIO() Implements abstract org.jruby.ext.ffi.MemoryObject.allocateMemoryIO.

allocateOut	back to summary
public static IRubyObject allocateOut(ThreadContext context, IRubyObject klass) Annotations @JRubyMethod name:new_out, alloc_out meta:true

allocateOut	back to summary
public static IRubyObject allocateOut(ThreadContext context, IRubyObject klass, IRubyObject clearArg) Annotations @JRubyMethod name:new_out, alloc_out meta:true

allocateStruct	back to summary
private static final Struct allocateStruct(ThreadContext context, IRubyObject klass, int flags)

clear	back to summary
public IRubyObject clear(ThreadContext context) Annotations @JRubyMethod name:clear

createStructClass	back to summary
public static RubyClass createStructClass(ThreadContext context, RubyModule FFI) Registers the StructLayout class in the JRuby runtime. Parameters context:ThreadContext the current thread context FFI:RubyModule reference to FFI module Returns:RubyClass The new class

createStructClass

back to summary

public static RubyClass createStructClass(ThreadContext context, RubyModule FFI)

Registers the StructLayout class in the JRuby runtime.

Parameters

context:ThreadContext: the current thread context
FFI:RubyModule: reference to FFI module

Returns:RubyClass

The new class

getCachedValue	back to summary
public final IRubyObject getCachedValue(StructLayout.Member member) Implements org.jruby.ext.ffi.StructLayout.Storage.getCachedValue.

getFieldValue	back to summary
public IRubyObject getFieldValue(ThreadContext context, IRubyObject fieldName) Annotations @JRubyMethod name:[]

getLayout	back to summary
public IRubyObject getLayout(ThreadContext context) Annotations @JRubyMethod name:cspec, layout

getMemory	back to summary
public final AbstractMemory getMemory()

getReferenceCache	back to summary
private Object[] getReferenceCache()

getStructLayout	back to summary
pack-priv static final StructLayout getStructLayout(ThreadContext context, IRubyObject structClass)

getStructSize	back to summary
pack-priv static final int getStructSize(ThreadContext context, IRubyObject structClass)

getValueCacheForWrite	back to summary
private IRubyObject[] getValueCacheForWrite()

initialize	back to summary
public IRubyObject initialize(ThreadContext context) Overrides org.jruby.RubyBasicObject.initialize. Annotations @Override @JRubyMethod name:initialize visibility:PRIVATE

initialize

back to summary

public IRubyObject initialize(ThreadContext context)

Overrides org.jruby.RubyBasicObject.initialize.

Annotations

@Override
@JRubyMethod
name:initialize
visibility:PRIVATE

initialize	back to summary
public IRubyObject initialize(ThreadContext context, IRubyObject ptr) Annotations @JRubyMethod name:initialize visibility:PRIVATE

initialize	back to summary
public IRubyObject initialize(ThreadContext context, IRubyObject[] args) Annotations @JRubyMethod name:initialize visibility:PRIVATE rest:true

initialize_copy	back to summary
public IRubyObject initialize_copy(ThreadContext context, IRubyObject other) Overrides org.jruby.RubyBasicObject.initialize_copy. Doc from org.jruby.RubyBasicObject.initialize_copy. Initializes this object as a copy of the original, that is the parameter to this object. Will make sure that the argument actually has the same real class as this object. It shouldn't be possible to initialize an object with something totally different. Parameters context:ThreadContext the thread context other:IRubyObject the original Returns:IRubyObject a copy unless the same thing Annotations @JRubyMethod name:initialize_copy visibility:PRIVATE

initialize_copy

back to summary

public IRubyObject initialize_copy(ThreadContext context, IRubyObject other)

Overrides org.jruby.RubyBasicObject.initialize_copy.

Doc from org.jruby.RubyBasicObject.initialize_copy.

Initializes this object as a copy of the original, that is the parameter to this object. Will make sure that the argument actually has the same real class as this object. It shouldn't be possible to initialize an object with something totally different.

Parameters

context:ThreadContext: the thread context
other:IRubyObject: the original

Returns:IRubyObject

a copy unless the same thing

Annotations

@JRubyMethod
name:initialize_copy
visibility:PRIVATE

initReferenceCache	back to summary
private Object[] initReferenceCache()

initValueCache	back to summary
private IRubyObject[] initValueCache()

isStruct	back to summary
pack-priv static final boolean isStruct(ThreadContext context, RubyClass klass)

members	back to summary
public static IRubyObject members(ThreadContext context, IRubyObject structClass) Annotations @JRubyMethod name:members meta:true

members	back to summary
public IRubyObject members(ThreadContext context) Annotations @JRubyMethod name:members

null_p	back to summary
public IRubyObject null_p(ThreadContext context) Annotations @JRubyMethod name:null?

offset_of	back to summary
public static IRubyObject offset_of(ThreadContext context, IRubyObject structClass, IRubyObject fieldName) Annotations @JRubyMethod name:offset_of meta:true

offset_of	back to summary
public IRubyObject offset_of(ThreadContext context, IRubyObject fieldName) Annotations @JRubyMethod name:offset_of

offsets	back to summary
public static IRubyObject offsets(ThreadContext context, IRubyObject structClass) Annotations @JRubyMethod name:offsets meta:true

offsets	back to summary
public IRubyObject offsets(ThreadContext context) Annotations @JRubyMethod name:offsets

order	back to summary
public final IRubyObject order(ThreadContext context) Annotations @JRubyMethod name:order

order	back to summary
public final IRubyObject order(ThreadContext context, IRubyObject byte_order) Annotations @JRubyMethod name:order

pointer	back to summary
public IRubyObject pointer(ThreadContext context) Annotations @JRubyMethod name:pointer, to_ptr

putCachedValue	back to summary
public final void putCachedValue(StructLayout.Member member, IRubyObject value) Implements org.jruby.ext.ffi.StructLayout.Storage.putCachedValue.

putReference	back to summary
public void putReference(StructLayout.Member member, Object value) Implements org.jruby.ext.ffi.StructLayout.Storage.putReference.

set_layout	back to summary
public static IRubyObject set_layout(ThreadContext context, IRubyObject structClass, IRubyObject layout) Annotations @JRubyMethod name:layout= meta:true

setFieldValue	back to summary
public IRubyObject setFieldValue(ThreadContext context, IRubyObject fieldName, IRubyObject fieldValue) Annotations @JRubyMethod name:[]=

size	back to summary
public static IRubyObject size(ThreadContext context, IRubyObject structClass) Annotations @JRubyMethod name:size meta:true

size	back to summary
public IRubyObject size(ThreadContext context) Annotations @JRubyMethod name:size

values	back to summary
public IRubyObject values(ThreadContext context) Annotations @JRubyMethod name:values

public Class Struct

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail