public
Description: ruby lang (www.ruby-lang.org) svn mirror
Homepage: http://svn.ruby-lang.org/repos/ruby/
Clone URL: git://github.com/juretta/ruby.git
ruby / doc / forwardable.rd
100644 84 lines (52 sloc) 2.178 kb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 -- forwardable.rb
            
                                                $Release Version: 1.1 $
                                                $Revision$
            Original version by Tosh
 
=begin
 
= Forwardable
 
A Module to define delegations for selected methods to a class.
 
== Usage
 
Using through extending the class.
  
  class Foo
    extend Forwardable
 
    def_delegators("@out", "printf", "print")
    def_delegators(:@in, :gets)
    def_delegator(:@contents, :[], "content_at")
  end
  f = Foo.new
  f.printf ...
  f.gets
  f.content_at(1)
 
== Methods
 
--- Forwardable#def_instance_delegators(accessor, *methods)
 
      adding the delegations for each method of ((|methods|)) to
      ((|accessor|)).
 
--- Forwardable#def_instance_delegator(accessor, method, ali = method)
      
      adding the delegation for ((|method|)) to ((|accessor|)). When
      you give optional argument ((|ali|)), ((|ali|)) is used as the
      name of the delegation method, instead of ((|method|)).
 
--- Forwardable#def_delegators(accessor, *methods)
 
      the alias of ((|Forwardable#def_instance_delegators|)).
 
--- Forwardable#def_delegator(accessor, method, ali = method)
      
      the alias of ((|Forwardable#def_instance_delegator|)).
 
= SingleForwardable
 
a Module to define delegations for selected methods to an object.
 
== Usage
 
Using through extending the object.
 
  g = Goo.new
  g.extend SingleForwardable
  g.def_delegator("@out", :puts)
  g.puts ...
 
== Methods
 
--- SingleForwardable#def_singleton_delegators(accessor, *methods)
 
      adding the delegations for each method of ((|methods|)) to
      ((|accessor|)).
 
--- SingleForwardable#def_singleton_delegator(accessor, method, ali = method)
 
      adding the delegation for ((|method|)) to ((|accessor|)). When
      you give optional argument ((|ali|)), ((|ali|)) is used as the
      name of the delegation method, instead of ((|method|)).
 
--- SingleForwardable#def_delegators(accessor, *methods)
 
      the alias of ((|SingleForwardable#def_instance_delegators|)).
 
--- SingleForwardable#def_delegator(accessor, method, ali = method)
 
      the alias of ((|SingleForwardable#def_instance_delegator|)).
=end