Module: GC

Defined in:

gc.c

Class Method Summary

• .disable ⇒ Boolean

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

• .enable ⇒ Boolean

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

• .start ⇒ Object

  Initiates garbage collection, unless manually disabled.

Instance Method Summary

• #garbage_collect ⇒ Object

  Initiates garbage collection, unless manually disabled.

Class Method Details

.disable ⇒ Boolean

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

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

Returns:

• (Boolean)

# File 'gc.c'

VALUE
rb_gc_disable()
{
    int old = dont_gc;

    dont_gc = Qtrue;
    return old;
}

VALUE rb_mGC;

static struct gc_list {
    VALUE *varptr;
    struct gc_list *next;
}

.enable ⇒ Boolean

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

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

Returns:

• (Boolean)

# File 'gc.c'

VALUE
rb_gc_enable()
{
    int old = dont_gc;

    dont_gc = Qfalse;
    return old;
}

.start ⇒ nil .garbage_collect ⇒ nil .garbage_collect ⇒ nil

Initiates garbage collection, unless manually disabled.

Overloads:

• .start ⇒ nil

  Returns:

  • (nil)
• .garbage_collect ⇒ nil

  Returns:

  • (nil)
• .garbage_collect ⇒ nil

  Returns:

  • (nil)

# File 'gc.c'

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

Instance Method Details

#start ⇒ nil #garbage_collect ⇒ nil #garbage_collect ⇒ nil

Initiates garbage collection, unless manually disabled.

Overloads:

• #start ⇒ nil

  Returns:

  • (nil)
• #garbage_collect ⇒ nil

  Returns:

  • (nil)
• #garbage_collect ⇒ nil

  Returns:

  • (nil)

# File 'gc.c'

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