class SystemExit - Documentation for Ruby 4.0
Description: class SystemExit: Raised by +exit+ to initiate the termination of the script.
Keywords: ruby,class,SystemExit

🔍

No recent searches

# class SystemExit

Raised by `exit` to initiate the termination of the script.

### Public Class Methods

new → system_exit
new(status) → system_exit
new(status, msg) → system_exit
new(msg) → system_exit
Source

    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;
    }

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.

### Public Instance Methods

status → integer
Source

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

Return the status value associated with this system exit.

success? → true or false
Source

    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);
        return RBOOL(WIFEXITED(status) && WEXITSTATUS(status) == EXIT_SUCCESS);
    }

Returns `true` if exiting successful, `false` if not.