Extended maintenance of Ruby 1.9.3 ended on February 23, 2015. Read more

In Files

  • weakref.rb



Class/Module Index [+]



Weak Reference class that allows a referenced object to be garbage-collected. A WeakRef may be used exactly like the object it references.


foo = Object.new
foo = Object.new
p foo.to_s                  # original's class
foo = WeakRef.new(foo)
p foo.to_s                  # should be same class
p foo.to_s                  # should raise exception (recycled)

Public Class Methods

new(orig) click to toggle source

Creates a weak reference to orig

               # File weakref.rb, line 51
def initialize(orig)
  @__id = orig.object_id
  ObjectSpace.define_finalizer orig, @@final
  ObjectSpace.define_finalizer self, @@final
  @@mutex.synchronize {
    @@id_map[@__id] = [] unless @@id_map[@__id]
  @@id_map[@__id].push self.object_id
  @@id_rev_map[self.object_id] = @__id

Public Instance Methods

weakref_alive?() click to toggle source

Returns true if the referenced object is still alive.

               # File weakref.rb, line 80
def weakref_alive?
  @@id_rev_map[self.object_id] == @__id

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.