123456789_123456789_123456789_123456789_123456789_

Exception: SystemExit

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::Exception
Instance Chain:
self, ::Exception
Inherits: Exception
Defined in: error.c,
error.c

Overview

Raised by exit to initiate the termination of the script.

Class Attribute Summary

::Exception - Inherited

.to_tty?

Returns true if exception messages will be sent to a terminal device.

Class Method Summary

::Exception - Inherited

.exception

Returns an exception object of the same class as self; useful for creating a similar exception, but with a different message.
.new

Returns a new exception object.

Instance Attribute Summary

Instance Method Summary

::Exception - Inherited

#==

Returns whether object is the same class as self and its #message and #backtrace are equal to those of self.
#backtrace

Returns a backtrace value for self; the returned value depends on the form of the stored backtrace value:
#backtrace_locations

Returns a backtrace value for self; the returned value depends on the form of the stored backtrace value:
#cause

Returns the previous value of global variable $!, which may be nil (see Global Variables):
#detailed_message

Returns the message string with enhancements:
#exception

Returns an exception object of the same class as self; useful for creating a similar exception, but with a different message.
#full_message

Returns an enhanced message string:
#inspect

Returns a string representation of self:
#message

Returns #to_s.
#set_backtrace

Sets the backtrace value for self; returns the given +value:
#to_s

Returns a string representation of self:

Constructor Details

.new ⇒ system_exit .new(status) ⇒ system_exit .new(status, msg) ⇒ system_exit .new(msg) ⇒ system_exit

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.

[ GitHub ] 

  


# File 'error.c', line 2090



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 Attribute Details



  

    #success?  ⇒ Boolean  (readonly)  



  

    

Returns true if exiting successful, false if not.


  



  [ GitHub ]


  

  


# File 'error.c', line 2154



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


  







Instance Method Details



  

    #status  ⇒ Integer   



  

    

Return the status value associated with this system exit.


  



  [ GitHub ]


  

  


# File 'error.c', line 2140



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