123456789_123456789_123456789_123456789_123456789_

Class: WeakRef

Relationships & Source Files
Namespace Children
Exceptions:
RefError
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Delegator
Instance Chain:
self, Delegator
Inherits: Delegator
  • Object
Defined in: lib/weakref.rb

Overview

Weak Reference class that allows a referenced object to be garbage-collected.

A WeakRef may be used exactly like the object it references.

Usage:

foo = Object.new            # create a new object instance
p foo.to_s                  # original's class
foo = WeakRef.new(foo)      # reassign foo with WeakRef instance
p foo.to_s                  # should be same class
GC.start                    # start the garbage collector
p foo.to_s                  # should raise exception (recycled)

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(orig) ⇒ WeakRef

Creates a weak reference to orig

Raises an ArgumentError if the given orig is immutable, such as Symbol, Integer, or Float.

[ GitHub ] 

  


# File 'lib/weakref.rb', line 37



def initialize(orig)
  case orig
  when true, false, nil
    @delegate_sd_obj = orig
  else
    @@__map[self] = orig
  end
  super
end


  







Instance Attribute Details



  

    #weakref_alive?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the referenced object is still alive.


  





  


  [ GitHub ]


  

  


# File 'lib/weakref.rb', line 58



def weakref_alive?
  @@__map.key?(self) or defined?(@delegate_sd_obj)
end


  







Instance Method Details



  

    #__getobj__  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/weakref.rb', line 47



def __getobj__ # :nodoc:
  @@__map[self] or defined?(@delegate_sd_obj) ? @delegate_sd_obj :
    Kernel::raise(RefError, "Invalid Reference - probably recycled", Kernel::caller(2))
end


  








  

    #__setobj__(obj)  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/weakref.rb', line 52



def __setobj__(obj) # :nodoc:
end