123456789_123456789_123456789_123456789_123456789_

Class: FFI::DynamicLibrary::Symbol

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::FFI::Pointer, ::FFI::AbstractMemory
Instance Chain:
self, ::FFI::Pointer, ::FFI::AbstractMemory
Inherits: FFI::Pointer
Defined in: ext/ffi_c/DynamicLibrary.c

Overview

An instance of this class represents a library symbol. It may be a pointer to a function or to a variable.

Constant Summary

::FFI::AbstractMemory - Inherited

LONG_MAX

::FFI::Pointer - Inherited

NULL, SIZE

Class Method Summary

::FFI::Pointer - Inherited

.new

A new instance of ::FFI::Pointer.
.size

Return the size of a pointer on the current platform, in bytes.

Instance Attribute Summary

::FFI::Pointer - Inherited

#autorelease=, #autorelease?, #null?

::FFI::AbstractMemory - Inherited

#size_limit?

Return true if self has a size limit.

Instance Method Summary

::FFI::Pointer - Inherited

#+, #==,
#address

Alias for Pointer#to_i.
#free,
#initialize_copy

This method is internally used by #dup and #clone.
#inspect

Alias for Pointer#to_s.
#order

Get or set self‘s endianness.
#read

Read pointer’s contents as type
#read_array_of_type

Read an array of type of length length.
#read_string

Read pointer’s contents as a string, or the first len bytes of the equivalent string if len is not nil.
#read_string_length

Read the first len bytes of pointer’s contents as a string.
#read_string_to_null

Read pointer’s contents as a string.
#slice, #to_i, #to_ptr, #to_s, #type_size,
#write

Write value of type type to pointer’s content.
#write_array_of_type

Write ary in pointer’s contents as type.
#write_string

Write str in pointer’s contents, or first len bytes if len is not nil.
#write_string_length

Write len first bytes of str in pointer’s contents.

::FFI::AbstractMemory - Inherited

#[], #__copy_from__, #clear,
#freeze

Freeze the ::FFI::AbstractMemory object and unset the writable flag.
#get, #get_array_of_double, #get_array_of_float,
#get_array_of_float32

Alias for AbstractMemory#get_array_of_float.
#get_array_of_float64

Alias for AbstractMemory#get_array_of_double.
#get_array_of_pointer, #get_array_of_string, #get_bytes, #get_double, #get_float,
#get_float32

Alias for AbstractMemory#get_float.
#get_float64

Alias for AbstractMemory#get_double.
#get_pointer, #get_string, #put, #put_array_of_double, #put_array_of_float,
#put_array_of_float32

Alias for AbstractMemory#put_array_of_float.
#put_array_of_float64

Alias for AbstractMemory#put_array_of_double.
#put_array_of_pointer, #put_bytes, #put_double, #put_float,
#put_float32

Alias for AbstractMemory#put_float.
#put_float64

Alias for AbstractMemory#put_double.
#put_pointer, #put_string, #read_array_of_double, #read_array_of_float, #read_array_of_pointer, #read_array_of_string, #read_bytes, #read_double, #read_float, #read_pointer, #size,
#total

Alias for AbstractMemory#size.
#type_size, #write_array_of_double, #write_array_of_float, #write_array_of_pointer, #write_bytes, #write_double, #write_float, #write_pointer

Constructor Details

This class inherits a constructor from FFI::Pointer

Instance Method Details

#initialize_copy(other) NOT(CALL)

[ GitHub ] 

  


# File 'ext/ffi_c/DynamicLibrary.c', line 264



static VALUE
symbol_initialize_copy(VALUE self, VALUE other)
{
    rb_raise(rb_eRuntimeError, "cannot duplicate symbol");
    return Qnil;
}


  








  

    

      #inspect  
      Inspect  
    

  



  

    
  





  


  [ GitHub ]


  

  


# File 'ext/ffi_c/DynamicLibrary.c', line 315



static VALUE
symbol_inspect(VALUE self)
{
    LibrarySymbol* sym;
    char buf[256];

    TypedData_Get_Struct(self, LibrarySymbol, &library_symbol_data_type, sym);
    snprintf(buf, sizeof(buf), "#<FFI::DynamicLibrary::Symbol name=%s address=%p>",
             StringValueCStr(sym->name), sym->base.memory.address);
    return rb_str_new2(buf);
}