Module GC
In: gc.c

The GC module provides an interface to Ruby‘s mark and sweep garbage collection mechanism. Some of the underlying methods are also available via the ObjectSpace module.

Methods

count   disable   enable   garbage_collect   start   stress   stress=  

Public Class methods

GC.count → Integer

The number of times GC occured.

It returns the number of times GC occured since the process started.

GC.disable => true or false

Disables garbage collection, returning true if garbage collection was already disabled. 

   GC.disable   #=> false
   GC.disable   #=> true
GC.enable => true or false

Enables garbage collection, returning true if garbage collection was previously disabled. 

   GC.disable   #=> false
   GC.enable    #=> true
   GC.enable    #=> false
GC.start => nil
gc.garbage_collect => nil
ObjectSpace.garbage_collect => nil

Initiates garbage collection, unless manually disabled.

GC.stress => true or false

returns current status of GC stress mode.

GC.stress = bool => bool

updates GC stress mode.

When GC.stress = true, GC is invoked for all GC opportunity: all memory and object allocation.

Since it makes Ruby very slow, it is only for debugging.

Public Instance methods

GC.start => nil
gc.garbage_collect => nil
ObjectSpace.garbage_collect => nil

Initiates garbage collection, unless manually disabled.

[Validate]

ruby-doc.org is hosted and maintained by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.