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
<code>TrueClass</code> 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)

1226
1227
1228
1229
1230
# File 'object.c', line 1226

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)

85
86
87
88
89
90
91
92
93
94
# File 'object.c', line 85

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

    if (obj1 == obj2) return Qtrue;
    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.


1264
1265
1266
1267
1268
# File 'object.c', line 1264

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

#to_sObject Also known as: inspect

The string representation of true is “true”.


1211
1212
1213
1214
1215
# File 'object.c', line 1211

static VALUE
true_to_s(VALUE obj)
{
    return rb_usascii_str_new2("true");
}

#|(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)

1248
1249
1250
1251
1252
# File 'object.c', line 1248

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