In Files

  • gc.c

GC

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.

Public Class Methods

disable => true or false click to toggle source

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

GC.disable   #=> false
GC.disable   #=> true
 
               VALUE
rb_gc_disable()
{
    int old = dont_gc;

    dont_gc = Qtrue;
    return old;
}
            
enable => true or false click to toggle source

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

GC.disable   #=> false
GC.enable    #=> true
GC.enable    #=> false
 
               VALUE
rb_gc_enable()
{
    int old = dont_gc;

    dont_gc = Qfalse;
    return old;
}
            
start => nil click to toggle source

Initiates garbage collection, unless manually disabled.

 
               VALUE
rb_gc_start()
{
    rb_gc();
    return Qnil;
}
            

Public Instance Methods

garbage_collect => nil click to toggle source
garbage_collect => nil

Initiates garbage collection, unless manually disabled.

 
               VALUE
rb_gc_start()
{
    rb_gc();
    return Qnil;
}
            

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.

blog comments powered by Disqus