Methods are public by default: the compiler will always let you invoke them. Because public is the default if there is no public
keyword.
Methods can be marked as private
or protected
.
A private
method can only be invoked without a receiver, that is, without something before the dot:
class Person
private def say(message)
puts message
end
def say_hello
say "hello" # OK, no receiver
self.say "hello" # Error, self is a receiver
other = Person.new "Other"
other.say "hello" # Error, other is a receiver
end
end
Note that private
methods are visible by subclasses:
class Employee < Person
def say_bye
say "bye" # OK
end
end
A protected
method can only be invoked on instances of the same type as the current type:
class Person
protected def say(message)
puts message
end
def say_hello
say "hello" # OK, implicit self is a Person
self.say "hello" # OK, self is a Person
other = Person.new "Other"
other.say "hello" # OK, other is a Person
end
end
class Animal
def make_a_person_talk
person = Person.new
person.say "hello" # Error, person is a Person
# but current type is an Animal
end
end
one_more = Person.new "One more"
one_more.say "hello" # Error, one_more is a Person
# but current type is the Program
A protected
class method can be invoked from an instance method and the other way around:
class Person
protected def self.say(message)
puts message
end
def say_hello
Person.say "hello" # OK
end
end
A private
top-level method is only visible in the current file.
# In file one.cr
private def greet
puts "Hello"
end
greet #=> "Hello"
# In file two.cr
require "./one"
greet # undefined local variable or method 'greet'
This allows you to define helper methods in a file that will only be known in that file.