Class: TrueClass

Inherits:
Object show all
Defined in:
object.c,
object.c

Overview

*********************************************************************

The global value <code>true</code> is the only instance of class
TrueClass and represents a logically true value in
boolean expressions. The class provides operators allowing
<code>true</code> to be used in logical expressions.

Instance Method Summary collapse

Instance Method Details

#&(obj) ⇒ Boolean

And—Returns false if obj is nil or false, true otherwise.

Returns:

  • (Boolean) 

1477
1478
1479
1480
1481
 
# File 'object.c', line 1477

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

#===(other) ⇒ Boolean

Case Equality – For class Object, effectively the same as calling #==, but typically overridden by descendants to provide meaningful semantics in case statements.

Returns:

  • (Boolean) 

144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'object.c', line 144

VALUE
rb_equal(VALUE obj1, VALUE obj2)
{
    VALUE result;

    if (obj1 == obj2) return Qtrue;
    result = rb_equal_opt(obj1, obj2);
    if (result == Qundef) {
	result = rb_funcall(obj1, id_eq, 1, obj2);
    }
    if (RTEST(result)) return Qtrue;
    return Qfalse;
}

#^(obj) ⇒ Object

Exclusive Or—Returns true if obj is nil or false, false otherwise.


1515
1516
1517
1518
1519
 
# File 'object.c', line 1515

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

#to_s ⇒ Object Also known as: inspect

The string representation of true is “true”.


1462
1463
1464
1465
1466
 
# File 'object.c', line 1462

static VALUE
true_to_s(VALUE obj)
{
    return rb_cTrueClass_to_s;
}

#|(obj) ⇒ true

Or—Returns true. As obj is an argument to a method call, it is always evaluated; there is no short-circuit evaluation in this case.

true |  puts("or")
true || puts("logical or")

produces:

or

Returns:

  • (true) 

1499
1500
1501
1502
1503
 
# File 'object.c', line 1499

static VALUE
true_or(VALUE obj, VALUE obj2)
{
    return Qtrue;
}