Class: TrueClass

Inherits:

Object

• Object
• TrueClass

Defined in:

object.c,
object.c

Overview

The class of the singleton object true.

Several of its methods act as operators:

• #&

• #|

• #===

• #^

One other method:

• #to_s and its alias #inspect.

Instance Method Summary

• #&(object) ⇒ Boolean

  Returns false if object is false or nil, true otherwise:.

• #=== ⇒ Object
• #^(object) ⇒ Object

  Returns true if object is false or nil, false otherwise:.

• #to_s ⇒ Object (also: #inspect)

  Returns string 'true':.

• #|(object) ⇒ true

  Returns true:.

Instance Method Details

#&(object) ⇒ Boolean

Returns false if object is false or nil, true otherwise:

true & Object.new # => true true & false # => false true & nil # => false

Returns:

• (Boolean)

# File 'object.c', line 1473

static VALUE
true_and(VALUE obj, VALUE obj2)
{
    return RBOOL(RTEST(obj2));
}

#=== ⇒ Object

#^(object) ⇒ Object

Returns true if object is false or nil, false otherwise:

true ^ Object.new # => false
true ^ false      # => true
true ^ nil        # => true

# File 'object.c', line 1517

static VALUE
true_xor(VALUE obj, VALUE obj2)
{
    return rb_obj_not(obj2);
}

#to_s ⇒ Object Also known as: inspect

Returns string 'true':

true.to_s # => "true"

TrueClass#inspect is an alias for TrueClass#to_s.

# File 'object.c', line 1454

VALUE
rb_true_to_s(VALUE obj)
{
    return rb_cTrueClass_to_s;
}

#|(object) ⇒ true

Returns true:

true | Object.new # => true
true | false      # => true
true | nil        # => true

Argument object is evaluated. This is different from true with the short-circuit operator, whose operand is evaluated only if necessary:

true | raise # => Raises RuntimeError.
true || raise # => true

Returns:

• (true)

# File 'object.c', line 1498

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