Reference

class Reference

Overview

Reference is the base class of classes you define in your program- It is set as a class' superclass when you don't specify one:

class MyClass # < Reference
end

A reference type is passed by reference: when you pass it to methods, return it from methods or assign it to variables, a pointer is actually passed.

Invoking .new on a Reference allocates a new instance on the heap- The instance's memory is automatically freed (garbage-collected) when the instance is no longer referred by any other entity in the program-

Direct Known Subclasses

Defined in:

primitives.cr
reference.cr

Class Method Summary

.new

Instance Method Summary

#==(other : self)
Returns true if this reference is the same as other.
#==(other)
Returns false (other can only be a Value here)-
#dup
Returns a shallow copy of this object.
#hash
Returns this reference's #object_id as the hash value.
#inspect(io : IO) : Nil
#object_id : UInt64
Returns a UInt64 that uniquely identifies this object.
#pretty_print(pp) : Nil
#same?(other : Reference)
Returns true if this reference is the same as other.
#same?(other : Nil)
Returns false: a reference is never nil.
#to_s(io : IO) : Nil

Class Method Detail

def self.newSource

Instance Method Detail

def ==(other : self)Source

Returns true if this reference is the same as other. Invokes #same?.

def ==(other)Source

Returns false (other can only be a Value here)-

def dupSource

Returns a shallow copy of this object.

This allocates a new object and copies the contents of self into it.

def hashSource

Returns this reference's #object_id as the hash value.

def inspect(io : IO) : Nil Source

def object_id : UInt64 Source

Returns a UInt64 that uniquely identifies this object.

The returned value is the memory address of this object.

string = "hello"
string.object_id # => 4460249568

pointer = Pointer(String).new(string.object_id)
string2 = pointer.as(String)
string2.object_id == string.object_id # => true

def pretty_print(pp) : Nil Source

def same?(other : Reference)Source

Returns true if this reference is the same as other. This is only true if this reference's #object_id is the same as other's.

def same?(other : Nil)Source

Returns false: a reference is never nil.

def to_s(io : IO) : Nil Source

© 2012–2017 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.22.0/Reference.html

Reference

class Reference

Overview

Direct Known Subclasses

Defined in:

Class Method Summary

Instance Method Summary

Instance methods inherited from class `Object`

Class methods inherited from class `Object`

Class Method Detail

def self.newSource

Instance Method Detail

def ==(other : self)Source

def ==(other)Source

def dupSource

def hashSource

def inspect(io : IO) : Nil Source

def object_id : UInt64 Source

def pretty_print(pp) : Nil Source

def same?(other : Reference)Source

def same?(other : Nil)Source

def to_s(io : IO) : Nil Source

Reference

class Reference

Overview

Direct Known Subclasses

Defined in:

Class Method Summary

Instance Method Summary

Instance methods inherited from class Object

Class methods inherited from class Object

Class Method Detail

def self.newSource

Instance Method Detail

def ==(other : self)Source

def ==(other)Source

def dupSource

def hashSource

def inspect(io : IO) : NilSource

def object_id : UInt64Source

def pretty_print(pp) : NilSource

def same?(other : Reference)Source

def same?(other : Nil)Source

def to_s(io : IO) : NilSource

Instance methods inherited from class `Object`

Class methods inherited from class `Object`

def inspect(io : IO) : Nil Source

def object_id : UInt64 Source

def pretty_print(pp) : Nil Source

def to_s(io : IO) : Nil Source