Class: NilClass

Inherits:
Object show all
Defined in:
object.c

Overview

The class of the singleton object nil.

Instance Method Summary collapse

Instance Method Details

#&(obj) ⇒ false #&(obj) ⇒ false

And---Returns false. obj is always evaluated as it is the argument to a method call---there is no short-circuit evaluation in this case.

Overloads:

  • #&(obj) ⇒ false

    Returns:

    • (false)
  • #&(obj) ⇒ false

    Returns:

    • (false) 



# File 'object.c'

static VALUE
false_and(VALUE obj, VALUE obj2)
{
    return Qfalse;
}

#^(obj) ⇒ Boolean #^(obj) ⇒ Boolean

Exclusive Or---If obj is nil or false, returns false; otherwise, returns true.

Overloads:

  • #^(obj) ⇒ Boolean

    Returns:

    • (Boolean)
  • #^(obj) ⇒ Boolean

    Returns:

    • (Boolean) 



# File 'object.c'

static VALUE
false_xor(VALUE obj, VALUE obj2)
{
    return RTEST(obj2)?Qtrue:Qfalse;
}

#inspect ⇒ Object

Always returns the string "nil".




# File 'object.c'

static VALUE
nil_inspect(VALUE obj)
{
    return rb_usascii_str_new2("nil");
}

#nil? ⇒ Object

call_seq:

nil.nil?               -> true

Only the object nil responds true to nil?.




# File 'object.c'

static VALUE
rb_true(VALUE obj)
{
    return Qtrue;
}

#rationalize([eps]) ⇒ Object

Returns zero as a rational. An optional argument eps is always ignored.




# File 'rational.c'

static VALUE
nilclass_rationalize(int argc, VALUE *argv, VALUE self)
{
    rb_scan_args(argc, argv, "01", NULL);
    return nilclass_to_r(self);
}

#to_a ⇒ Array

Always returns an empty array.

nil.to_a   #=> []

Returns:




# File 'object.c'

/*
 * Document-method: to_a
 *
 *  call-seq:
 *     nil.to_a    -> []
 *
 *  Always returns an empty array.
 *
 *     nil.to_a   #=> []
 */

static VALUE
nil_to_a(VALUE obj)
{
    return rb_ary_new2(0);
}

#to_c ⇒ Object

Returns zero as a complex.




# File 'complex.c'

static VALUE
nilclass_to_c(VALUE self)
{
    return rb_complex_new1(INT2FIX(0));
}

#to_f ⇒ 0.0

Always returns zero.

nil.to_f   #=> 0.0

Returns:

  • (0.0) 



# File 'object.c'

static VALUE
nil_to_f(VALUE obj)
{
    return DBL2NUM(0.0);
}

#to_i ⇒ 0

Always returns zero.

nil.to_i   #=> 0

Returns:

  • (0) 



# File 'object.c'

static VALUE
nil_to_i(VALUE obj)
{
    return INT2FIX(0);
}

#to_r ⇒ Object

Returns zero as a rational.




# File 'rational.c'

static VALUE
nilclass_to_r(VALUE self)
{
    return rb_rational_new1(INT2FIX(0));
}

#to_s ⇒ Object

Always returns the empty string.




# File 'object.c'

static VALUE
nil_to_s(VALUE obj)
{
    return rb_usascii_str_new(0, 0);
}

#|(obj) ⇒ Boolean #|(obj) ⇒ Boolean

Or---Returns false if obj is nil or false; true otherwise.

Overloads:

  • #|(obj) ⇒ Boolean

    Returns:

    • (Boolean)
  • #|(obj) ⇒ Boolean

    Returns:

    • (Boolean) 



# File 'object.c'

static VALUE
false_or(VALUE obj, VALUE obj2)
{
    return RTEST(obj2)?Qtrue:Qfalse;
}