Module#private

private → nil

private(method_name) → method_name

private(method_name, method_name, ...) → array

private(array) → array

static VALUE
rb_mod_private(int argc, VALUE *argv, VALUE module)
{
    return set_visibility(argc, argv, module, METHOD_VISI_PRIVATE);
}

With no arguments, sets the default visibility for subsequently defined methods to private. With arguments, sets the named methods to have private visibility. String arguments are converted to symbols. An Array of Symbols and/or Strings is also accepted. If a single argument is passed, it is returned. If no argument is passed, nil is returned. If multiple arguments are passed, the arguments are returned as an array.

Example

module Mod
  def a()  end
  def b()  end
  private
  def c()  end
  private :a
end
Mod.private_instance_methods   #=> [:a, :c]

Note that to show a private method on RDoc, use :doc:.

Ruby version changes

3.1
- Module#private, public, protected, and module_function will now return their arguments. If a single argument is given, it is returned. If no arguments are given, nil is returned. If multiple arguments are given, they are returned as an array. [Feature #12495]
3.0
- Module#public, Module#protected, Module#private, Module#public_class_method, Module#private_class_method, toplevel “private” and “public” methods now accept single array argument with a list of method names. [Feature #17314]

See also #prepend_features #private_class_method #prepended #private_constant also in 4.1 · 4.0 · 3.4 · 3.2 · 3.1 · 3.0

‹ prev#prepend_features next ›#private_class_method