Exception: SystemExit

Inherits:

Exception

• Object
• Exception
• SystemExit

Defined in:

error.c,
error.c

Overview

Raised by exit to initiate the termination of the script.

Instance Method Summary

• #initialize(*args) ⇒ Object constructor

  Create a new SystemExit exception with the given status and message.

• #status ⇒ Fixnum

  Return the status value associated with this system exit.

• #success? ⇒ Boolean

  Returns true if exiting successful, false if not.

Methods inherited from Exception

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

Constructor Details

#new ⇒ Object #new(status) ⇒ Object #new(status, msg) ⇒ Object #new(msg) ⇒ Object

Create a new SystemExit exception with the given status and message. Status is true, false, or an integer. If status is not given, true is used.

# File 'error.c', line 1006

static VALUE
exit_initialize(int argc, VALUE *argv, VALUE exc)
{
    VALUE status;
    if (argc > 0) {
	status = *argv;

	switch (status) {
	  case Qtrue:
	    status = INT2FIX(EXIT_SUCCESS);
	    ++argv;
	    --argc;
	    break;
	  case Qfalse:
	    status = INT2FIX(EXIT_FAILURE);
	    ++argv;
	    --argc;
	    break;
	  default:
	    status = rb_check_to_int(status);
	    if (NIL_P(status)) {
		status = INT2FIX(EXIT_SUCCESS);
	    }
	    else {
#if EXIT_SUCCESS != 0
		if (status == INT2FIX(0))
		    status = INT2FIX(EXIT_SUCCESS);
#endif
		++argv;
		--argc;
	    }
	    break;
	}
    }
    else {
	status = INT2FIX(EXIT_SUCCESS);
    }
    rb_call_super(argc, argv);
    rb_ivar_set(exc, id_status, status);
    return exc;
}

Instance Method Details

#status ⇒ Fixnum

Return the status value associated with this system exit.

Returns:

• (Fixnum)

# File 'error.c', line 1056

static VALUE
exit_status(VALUE exc)
{
    return rb_attr_get(exc, id_status);
}

#success? ⇒ Boolean

Returns true if exiting successful, false if not.

Returns:

• (Boolean)

Returns:

• (Boolean)

# File 'error.c', line 1070

static VALUE
exit_success_p(VALUE exc)
{
    VALUE status_val = rb_attr_get(exc, id_status);
    int status;

    if (NIL_P(status_val))
	return Qtrue;
    status = NUM2INT(status_val);
    if (WIFEXITED(status) && WEXITSTATUS(status) == EXIT_SUCCESS)
	return Qtrue;

    return Qfalse;
}