Object
@return (see Struct#alignment)
# File lib/ffi/struct.rb, line 153 def self.alignment @layout.alignment end
# File lib/ffi/struct.rb, line 214 def self.auto_ptr @managed_type ||= Type::Mapped.new(ManagedStructConverter.new(self)) end
# File lib/ffi/struct.rb, line 192 def self.by_ref(flags = :inout) self.ptr(flags) end
@return [StructLayout] @overload layout
@return [StructLayout] Get struct layout.
@overload layout(*spec)
@param [Array<Symbol, Integer>,Array(Hash)] spec @return [StructLayout] Create struct layout from +spec+. @example Creating a layout from an array +spec+ class MyStruct < Struct layout :field1, :int, :field2, :pointer, :field3, :string end @example Creating a layout from an array +spec+ with offset class MyStructWithOffset < Struct layout :field1, :int, :field2, :pointer, 6, # set offset to 6 for this field :field3, :string end @example Creating a layout from a hash +spec+ (Ruby 1.9 only) class MyStructFromHash < Struct layout :field1 => :int, :field2 => :pointer, :field3 => :string end @note Creating a layout from a hash +spec+ is supported only for Ruby 1.9.
# File lib/ffi/struct.rb, line 249 def layout(*spec) # raise RuntimeError, "struct layout already defined for #{self.inspect}" if defined?(@layout) return @layout if spec.size == 0 builder = StructLayoutBuilder.new builder.union = self < Union builder.packed = @packed if defined?(@packed) builder.alignment = @min_alignment if defined?(@min_alignment) if spec[0].kind_of?(Hash) hash_layout(builder, spec) else array_layout(builder, spec) end builder.size = @size if defined?(@size) && @size > builder.size cspec = builder.build @layout = cspec unless self == Struct @size = cspec.size return cspec end
(see FFI::Type#members)
# File lib/ffi/struct.rb, line 158 def self.members @layout.members end
(see FFI::StructLayout#offset_of)
# File lib/ffi/struct.rb, line 168 def self.offset_of(name) @layout.offset_of(name) end
(see FFI::StructLayout#offsets)
# File lib/ffi/struct.rb, line 163 def self.offsets @layout.offsets end
# File lib/ffi/struct.rb, line 180 def self.ptr(flags = :inout) @ref_data_type ||= Type::Mapped.new(StructByReference.new(self)) end
Get struct size @return [Numeric]
# File lib/ffi/struct.rb, line 140 def self.size defined?(@layout) ? @layout.size : defined?(@size) ? @size : 0 end
# File lib/ffi/struct.rb, line 283 def aligned(alignment = 1) @min_alignment = alignment end
# File lib/ffi/struct.rb, line 273 def callback(params, ret) mod = enclosing_module FFI::CallbackInfo.new(find_type(ret, mod), params.map { |e| find_type(e, mod) }) end
# File lib/ffi/struct.rb, line 288 def enclosing_module begin mod = self.name.split("::")[0..-2].inject(Object) { |obj, c| obj.const_get(c) } (mod < FFI::Library || mod < FFI::Struct || mod.respond_to?(:find_type)) ? mod : nil rescue Exception nil end end
# File lib/ffi/struct.rb, line 298 def find_field_type(type, mod = enclosing_module) if type.kind_of?(Class) && type < Struct FFI::Type::Struct.new(type) elsif type.kind_of?(Class) && type < FFI::StructLayout::Field type elsif type.kind_of?(::Array) FFI::Type::Array.new(find_field_type(type[0]), type[1]) else find_type(type, mod) end end
# File lib/ffi/struct.rb, line 313 def find_type(type, mod = enclosing_module) if mod mod.find_type(type) end || FFI.find_type(type) end
# File lib/ffi/struct.rb, line 278 def packed(packed = 1) @packed = packed end
@return [Fixnum] Struct alignment
# File lib/ffi/struct.rb, line 99 def alignment self.class.alignment end
Clear the struct content. @return [self]
# File lib/ffi/struct.rb, line 127 def clear pointer.clear self end
(see FFI::StructLayout#members)
# File lib/ffi/struct.rb, line 110 def members self.class.members end
(see FFI::StructLayout#offset_of)
# File lib/ffi/struct.rb, line 105 def offset_of(name) self.class.offset_of(name) end
(see FFI::StructLayout#offsets)
# File lib/ffi/struct.rb, line 121 def offsets self.class.offsets end
Get struct size @return [Numeric]
# File lib/ffi/struct.rb, line 94 def size self.class.size end
Get {Pointer} to struct content. @return [AbstractMemory]
# File lib/ffi/struct.rb, line 134 def to_ptr pointer end
@return [Array] Get array of values from Struct fields.
# File lib/ffi/struct.rb, line 116 def values members.map { |m| self[m] } end
Generated with the Darkfish Rdoc Generator 2.