-
Notifications
You must be signed in to change notification settings - Fork 34
Expand file tree
/
Copy pathstd.container.html
More file actions
178 lines (138 loc) · 5.67 KB
/
std.container.html
File metadata and controls
178 lines (138 loc) · 5.67 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>stdlib 41.2.2 Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>stdlib 41.2.2</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Objects">Objects</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><strong>std.container</strong></li>
<li><a href="../classes/std.list.html">std.list</a></li>
<li><a href="../classes/std.object.html">std.object</a></li>
<li><a href="../classes/std.optparse.html">std.optparse</a></li>
<li><a href="../classes/std.set.html">std.set</a></li>
<li><a href="../classes/std.strbuf.html">std.strbuf</a></li>
<li><a href="../classes/std.tree.html">std.tree</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/std.html">std</a></li>
<li><a href="../modules/std.debug.html">std.debug</a></li>
<li><a href="../modules/std.functional.html">std.functional</a></li>
<li><a href="../modules/std.io.html">std.io</a></li>
<li><a href="../modules/std.math.html">std.math</a></li>
<li><a href="../modules/std.operator.html">std.operator</a></li>
<li><a href="../modules/std.package.html">std.package</a></li>
<li><a href="../modules/std.strict.html">std.strict</a></li>
<li><a href="../modules/std.string.html">std.string</a></li>
<li><a href="../modules/std.table.html">std.table</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>std.container</code></h1>
<p>Container prototype.</p>
<p>
<p> A container is a <a href="../classes/std.object.html#">std.object</a> with no methods. It's functionality is
instead defined by its <em>meta</em>methods.</p>
<p> Where an Object uses the <code>__index</code> metatable entry to hold object
methods, a Container stores its contents using <code>__index</code>, preventing
it from having methods in there too.</p>
<p> Although there are no actual methods, Containers are free to use
metamethods (<code>__index</code>, <code>__sub</code>, etc) and, like Objects, can supply
module functions by listing them in <code>_functions</code>. Also, since a
<a href="../classes/std.container.html#">std.container</a> is a <a href="../classes/std.object.html#">std.object</a>, it can be passed to the
<a href="../classes/std.object.html#">std.object</a> module functions, or anywhere else a <a href="../classes/std.object.html#">std.object</a> is
expected.</p>
<p> When making your own prototypes, derive from <a href="../classes/std.container.html#">std.container</a> if you want
to access the contents of your objects with the <code>[]</code> operator, or from
<a href="../classes/std.object.html#">std.object</a> if you want to access the functionality of your objects with
named object methods.</p>
<h2> Prototype Chain</h2>
<pre>
<span class="global">table</span>
<span class="backtick">`-> Object
`</span>-> Container
</pre>
</p>
<h2><a href="#Objects">Objects</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#std.container.Container">std.container.Container</a></td>
<td class="summary">Container prototype.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Objects"></a>Objects</h2>
<dl class="function">
<dt>
<a name = "std.container.Container"></a>
<strong>std.container.Container</strong>
</dt>
<dd>
Container prototype. </p>
<p> Container also inherits all the fields and methods from
<a href="../classes/std.object.html#std.object.Object">std.object.Object</a>.
<h3>Fields:</h3>
<ul>
<li><span class="parameter">_type</span>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
object name
(<em>default</em> "Container")
</li>
</ul>
<h3>See also:</h3>
<ul>
<li><a href="../classes/std.object.html#">std.object</a></li>
<li><a href="../classes/std.object.html#std.object:__call">std.object.__call</a></li>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example"><span class="keyword">local</span> std = <span class="global">require</span> <span class="string">"std"</span>
<span class="keyword">local</span> Container = std.container {}
<span class="keyword">local</span> Graph = Container {
_type = <span class="string">"Graph"</span>,
_functions = {
nodes = <span class="keyword">function</span> (graph)
<span class="keyword">local</span> n = <span class="number">0</span>
<span class="keyword">for</span> _ <span class="keyword">in</span> std.<span class="global">pairs</span> (graph) <span class="keyword">do</span> n = n + <span class="number">1</span> <span class="keyword">end</span>
<span class="keyword">return</span> n
<span class="keyword">end</span>,
},
}
<span class="keyword">local</span> g = Graph { <span class="string">"node1"</span>, <span class="string">"node2"</span> }
<span class="comment">--> 2
</span><span class="global">print</span> (Graph.nodes (g))</pre>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2018-09-16 19:20:25 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>