Exception: SystemExit

Inherits:
Exception show all
Defined in:
error.c

Overview

Raised by exit to initiate the termination of the script.

Instance Method Summary collapse

Methods inherited from Exception

#==, #backtrace, exception, #exception, #inspect, #message, #set_backtrace, #to_s

Constructor Details

#new(status = 0) ⇒ Object

Create a new SystemExit exception with the given status.



# File 'error.c'

/*
 * call-seq:
 *   SystemExit.new(status=0)   -> system_exit
 *
 * Create a new +SystemExit+ exception with the given status.
 */

static VALUE
exit_initialize(int argc, VALUE *argv, VALUE exc)
{
    VALUE status = INT2FIX(EXIT_SUCCESS);
    if (argc > 0 && FIXNUM_P(argv[0])) {
    status = *argv++;
    --argc;
    }
    rb_call_super(argc, argv);
    rb_iv_set(exc, "status", status);
    return exc;
}

Instance Method Details

#statusFixnum

Return the status value associated with this system exit.

Returns:



# File 'error.c'

/*
 * call-seq:
 *   system_exit.status   -> fixnum
 *
 * Return the status value associated with this system exit.
 */

static VALUE
exit_status(VALUE exc)
{
    return rb_attr_get(exc, rb_intern("status"));
}

#success?Boolean

Returns true if exiting successful, false if not.

Returns:

  • (Boolean)


# File 'error.c'

/*
 * call-seq:
 *   system_exit.success?  -> true or false
 *
 * Returns +true+ if exiting successful, +false+ if not.
 */

static VALUE
exit_success_p(VALUE exc)
{
    VALUE status = rb_attr_get(exc, rb_intern("status"));
    if (NIL_P(status)) return Qtrue;
    if (status == INT2FIX(EXIT_SUCCESS)) return Qtrue;
    return Qfalse;
}