mucgly 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,1084 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: EasyFile::Write
8
+
9
+ &mdash; Documentation by YARD 0.8.6.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (W)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../EasyFile.html" title="EasyFile (module)">EasyFile</a></span></span>
36
+ &raquo;
37
+ <span class="title">Write</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: EasyFile::Write
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName"><span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next"><span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></li>
82
+
83
+ <li class="next">EasyFile::Write</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+ <dt class="r2 last">Defined in:</dt>
99
+ <dd class="r2 last">lib/easyfile.rb</dd>
100
+
101
+ </dl>
102
+ <div class="clear"></div>
103
+
104
+ <h2>Overview</h2><div class="docstring">
105
+ <div class="discussion">
106
+
107
+ <p>Write file.</p>
108
+
109
+ <p>Features:</p>
110
+ <ul><li>
111
+ <p>Line counting.</p>
112
+ </li><li>
113
+ <p>Branching and joining.</p>
114
+ </li><li>
115
+ <p>Stream output suppression.</p>
116
+ </li></ul>
117
+
118
+
119
+ </div>
120
+ </div>
121
+ <div class="tags">
122
+
123
+
124
+ </div>
125
+ <h2>Constant Summary</h2>
126
+
127
+
128
+
129
+
130
+ <h2>Constant Summary</h2>
131
+
132
+ <h3 class="inherited">Constants inherited
133
+ from <span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></h3>
134
+ <p class="inherited"><span class='object_link'><a href="InOut.html#FILEMODEMAP-constant" title="EasyFile::InOut::FILEMODEMAP (constant)">InOut::FILEMODEMAP</a></span></p>
135
+
136
+
137
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
138
+ <ul class="summary">
139
+
140
+ <li class="public ">
141
+ <span class="summary_signature">
142
+
143
+ <a href="#enabled-instance_method" title="#enabled (instance method)">- (Object) <strong>enabled</strong> </a>
144
+
145
+
146
+
147
+ </span>
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'>
161
+ <p>Output is enabled.</p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#flush-instance_method" title="#flush (instance method)">- (Object) <strong>flush</strong> </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Flush after each write.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></h3>
201
+ <p class="inherited"><span class='object_link'><a href="InOut.html#absname-instance_method" title="EasyFile::InOut#absname (method)">#absname</a></span>, <span class='object_link'><a href="InOut.html#filename-instance_method" title="EasyFile::InOut#filename (method)">#filename</a></span>, <span class='object_link'><a href="InOut.html#io-instance_method" title="EasyFile::InOut#io (method)">#io</a></span>, <span class='object_link'><a href="InOut.html#line-instance_method" title="EasyFile::InOut#line (method)">#line</a></span>, <span class='object_link'><a href="InOut.html#mode-instance_method" title="EasyFile::InOut#mode (method)">#mode</a></span>, <span class='object_link'><a href="InOut.html#parent-instance_method" title="EasyFile::InOut#parent (method)">#parent</a></span>, <span class='object_link'><a href="InOut.html#peers-instance_method" title="EasyFile::InOut#peers (method)">#peers</a></span></p>
202
+
203
+
204
+
205
+ <h2>
206
+ Class Method Summary
207
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
208
+ </h2>
209
+
210
+ <ul class="summary">
211
+
212
+ <li class="public ">
213
+ <span class="summary_signature">
214
+
215
+ <a href="#open-class_method" title="open (class method)">+ (Write) <strong>open</strong>(name) </a>
216
+
217
+
218
+
219
+ </span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>Create EasyFile::Write object and, open file with given name.</p>
231
+ </div></span>
232
+
233
+ </li>
234
+
235
+
236
+ </ul>
237
+
238
+ <h2>
239
+ Instance Method Summary
240
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
241
+ </h2>
242
+
243
+ <ul class="summary">
244
+
245
+ <li class="public ">
246
+ <span class="summary_signature">
247
+
248
+ <a href="#branch-instance_method" title="#branch (instance method)">- (Write) <strong>branch</strong>(fileid) </a>
249
+
250
+
251
+
252
+ </span>
253
+
254
+
255
+
256
+
257
+
258
+
259
+
260
+
261
+
262
+ <span class="summary_desc"><div class='inline'>
263
+ <p>Attach a file to existing Write stream i.e.</p>
264
+ </div></span>
265
+
266
+ </li>
267
+
268
+
269
+ <li class="public ">
270
+ <span class="summary_signature">
271
+
272
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Write) <strong>initialize</strong>(filename, absname = nil, io = nil) </a>
273
+
274
+
275
+
276
+ </span>
277
+
278
+
279
+ <span class="note title constructor">constructor</span>
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+ <span class="summary_desc"><div class='inline'>
289
+ <p>Create Write object.</p>
290
+ </div></span>
291
+
292
+ </li>
293
+
294
+
295
+ <li class="public ">
296
+ <span class="summary_signature">
297
+
298
+ <a href="#join-instance_method" title="#join (instance method)">- (Write) <strong>join</strong>(fileid) </a>
299
+
300
+
301
+
302
+ </span>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ <span class="summary_desc"><div class='inline'>
313
+ <p>Join the given filestream to this stream.</p>
314
+ </div></span>
315
+
316
+ </li>
317
+
318
+
319
+ <li class="public ">
320
+ <span class="summary_signature">
321
+
322
+ <a href="#puts-instance_method" title="#puts (instance method)">- (Object) <strong>puts</strong>(str) </a>
323
+
324
+
325
+
326
+ </span>
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+ <span class="summary_desc"><div class='inline'>
337
+ <p>Write with automatic newline.</p>
338
+ </div></span>
339
+
340
+ </li>
341
+
342
+
343
+ <li class="public ">
344
+ <span class="summary_signature">
345
+
346
+ <a href="#suppress-instance_method" title="#suppress (instance method)">- (Object) <strong>suppress</strong>(disable = true) </a>
347
+
348
+
349
+
350
+ </span>
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+ <span class="summary_desc"><div class='inline'>
361
+ <p>Suppress stream output.</p>
362
+ </div></span>
363
+
364
+ </li>
365
+
366
+
367
+ <li class="public ">
368
+ <span class="summary_signature">
369
+
370
+ <a href="#write-instance_method" title="#write (instance method)">- (Object) <strong>write</strong>(str) </a>
371
+
372
+
373
+
374
+ </span>
375
+
376
+
377
+
378
+
379
+
380
+
381
+
382
+
383
+
384
+ <span class="summary_desc"><div class='inline'>
385
+ <p>Write to all IOs.</p>
386
+ </div></span>
387
+
388
+ </li>
389
+
390
+
391
+ </ul>
392
+
393
+
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="InOut.html" title="EasyFile::InOut (class)">InOut</a></span></h3>
404
+ <p class="inherited"><span class='object_link'><a href="InOut.html#abspath-class_method" title="EasyFile::InOut.abspath (method)">abspath</a></span>, <span class='object_link'><a href="InOut.html#add-class_method" title="EasyFile::InOut.add (method)">add</a></span>, <span class='object_link'><a href="InOut.html#close-instance_method" title="EasyFile::InOut#close (method)">#close</a></span>, <span class='object_link'><a href="InOut.html#create-class_method" title="EasyFile::InOut.create (method)">create</a></span>, <span class='object_link'><a href="InOut.html#delete-class_method" title="EasyFile::InOut.delete (method)">delete</a></span>, <span class='object_link'><a href="InOut.html#get-class_method" title="EasyFile::InOut.get (method)">get</a></span>, <span class='object_link'><a href="InOut.html#getByAbsname-class_method" title="EasyFile::InOut.getByAbsname (method)">getByAbsname</a></span>, <span class='object_link'><a href="InOut.html#getList-class_method" title="EasyFile::InOut.getList (method)">getList</a></span>, <span class='object_link'><a href="InOut.html#open-instance_method" title="EasyFile::InOut#open (method)">#open</a></span>, <span class='object_link'><a href="InOut.html#standard%3F-class_method" title="EasyFile::InOut.standard? (method)">standard?</a></span></p>
405
+ <div id="constructor_details" class="method_details_list">
406
+ <h2>Constructor Details</h2>
407
+
408
+ <div class="method_details first">
409
+ <h3 class="signature first" id="initialize-instance_method">
410
+
411
+ - (<tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>) <strong>initialize</strong>(filename, absname = nil, io = nil)
412
+
413
+
414
+
415
+
416
+
417
+ </h3><div class="docstring">
418
+ <div class="discussion">
419
+
420
+ <p>Create Write object.</p>
421
+
422
+
423
+ </div>
424
+ </div>
425
+ <div class="tags">
426
+ <p class="tag_title">Parameters:</p>
427
+ <ul class="param">
428
+
429
+ <li>
430
+
431
+ <span class='name'>filename</span>
432
+
433
+
434
+ <span class='type'>(<tt><span class='object_link'><a href="String.html" title="EasyFile::String (class)">String</a></span></tt>)</span>
435
+
436
+
437
+
438
+ &mdash;
439
+ <div class='inline'>
440
+ <p>Relative path file name.</p>
441
+ </div>
442
+
443
+ </li>
444
+
445
+ <li>
446
+
447
+ <span class='name'>absname</span>
448
+
449
+
450
+ <span class='type'>(<tt><span class='object_link'><a href="String.html" title="EasyFile::String (class)">String</a></span></tt>)</span>
451
+
452
+
453
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
454
+
455
+
456
+ &mdash;
457
+ <div class='inline'>
458
+ <p>Absolute path file name (generated if not given).</p>
459
+ </div>
460
+
461
+ </li>
462
+
463
+ <li>
464
+
465
+ <span class='name'>io</span>
466
+
467
+
468
+ <span class='type'>(<tt>IO</tt>)</span>
469
+
470
+
471
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
472
+
473
+
474
+ &mdash;
475
+ <div class='inline'>
476
+ <p>IO handle.</p>
477
+ </div>
478
+
479
+ </li>
480
+
481
+ </ul>
482
+
483
+
484
+ </div><table class="source_code">
485
+ <tr>
486
+ <td>
487
+ <pre class="lines">
488
+
489
+
490
+ 506
491
+ 507
492
+ 508
493
+ 509
494
+ 510</pre>
495
+ </td>
496
+ <td>
497
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 506</span>
498
+
499
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_absname'>absname</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
500
+ <span class='kw'>super</span><span class='lparen'>(</span> <span class='symbol'>:write</span><span class='comma'>,</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_absname'>absname</span><span class='comma'>,</span> <span class='id identifier rubyid_io'>io</span> <span class='rparen'>)</span>
501
+ <span class='ivar'>@enabled</span> <span class='op'>=</span> <span class='kw'>true</span>
502
+ <span class='ivar'>@flush</span> <span class='op'>=</span> <span class='kw'>false</span>
503
+ <span class='kw'>end</span></pre>
504
+ </td>
505
+ </tr>
506
+ </table>
507
+ </div>
508
+
509
+ </div>
510
+
511
+ <div id="instance_attr_details" class="attr_details">
512
+ <h2>Instance Attribute Details</h2>
513
+
514
+
515
+ <span id="enabled=-instance_method"></span>
516
+ <div class="method_details first">
517
+ <h3 class="signature first" id="enabled-instance_method">
518
+
519
+ - (<tt>Object</tt>) <strong>enabled</strong>
520
+
521
+
522
+
523
+
524
+
525
+ </h3><div class="docstring">
526
+ <div class="discussion">
527
+
528
+ <p>Output is enabled.</p>
529
+
530
+
531
+ </div>
532
+ </div>
533
+ <div class="tags">
534
+
535
+
536
+ </div><table class="source_code">
537
+ <tr>
538
+ <td>
539
+ <pre class="lines">
540
+
541
+
542
+ 494
543
+ 495
544
+ 496</pre>
545
+ </td>
546
+ <td>
547
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 494</span>
548
+
549
+ <span class='kw'>def</span> <span class='id identifier rubyid_enabled'>enabled</span>
550
+ <span class='ivar'>@enabled</span>
551
+ <span class='kw'>end</span></pre>
552
+ </td>
553
+ </tr>
554
+ </table>
555
+ </div>
556
+
557
+
558
+ <span id="flush=-instance_method"></span>
559
+ <div class="method_details ">
560
+ <h3 class="signature " id="flush-instance_method">
561
+
562
+ - (<tt>Object</tt>) <strong>flush</strong>
563
+
564
+
565
+
566
+
567
+
568
+ </h3><div class="docstring">
569
+ <div class="discussion">
570
+
571
+ <p>Flush after each write.</p>
572
+
573
+
574
+ </div>
575
+ </div>
576
+ <div class="tags">
577
+
578
+
579
+ </div><table class="source_code">
580
+ <tr>
581
+ <td>
582
+ <pre class="lines">
583
+
584
+
585
+ 497
586
+ 498
587
+ 499</pre>
588
+ </td>
589
+ <td>
590
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 497</span>
591
+
592
+ <span class='kw'>def</span> <span class='id identifier rubyid_flush'>flush</span>
593
+ <span class='ivar'>@flush</span>
594
+ <span class='kw'>end</span></pre>
595
+ </td>
596
+ </tr>
597
+ </table>
598
+ </div>
599
+
600
+ </div>
601
+
602
+
603
+ <div id="class_method_details" class="method_details_list">
604
+ <h2>Class Method Details</h2>
605
+
606
+
607
+ <div class="method_details first">
608
+ <h3 class="signature first" id="open-class_method">
609
+
610
+ + (<tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>) <strong>open</strong>(name)
611
+
612
+
613
+
614
+
615
+
616
+ </h3><div class="docstring">
617
+ <div class="discussion">
618
+
619
+ <p>Create EasyFile::Write object and, open file with given name.</p>
620
+
621
+
622
+ </div>
623
+ </div>
624
+ <div class="tags">
625
+ <p class="tag_title">Parameters:</p>
626
+ <ul class="param">
627
+
628
+ <li>
629
+
630
+ <span class='name'>name</span>
631
+
632
+
633
+ <span class='type'>(<tt><span class='object_link'><a href="String.html" title="EasyFile::String (class)">String</a></span></tt>)</span>
634
+
635
+
636
+
637
+ &mdash;
638
+ <div class='inline'>
639
+ <p>Relative path name for file.</p>
640
+ </div>
641
+
642
+ </li>
643
+
644
+ </ul>
645
+
646
+ <p class="tag_title">Returns:</p>
647
+ <ul class="return">
648
+
649
+ <li>
650
+
651
+
652
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>)</span>
653
+
654
+
655
+
656
+ &mdash;
657
+ <div class='inline'>
658
+ <p>EasyFile handle.</p>
659
+ </div>
660
+
661
+ </li>
662
+
663
+ </ul>
664
+
665
+ </div><table class="source_code">
666
+ <tr>
667
+ <td>
668
+ <pre class="lines">
669
+
670
+
671
+ 488
672
+ 489
673
+ 490</pre>
674
+ </td>
675
+ <td>
676
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 488</span>
677
+
678
+ <span class='kw'>def</span> <span class='const'>Write</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span> <span class='rparen'>)</span>
679
+ <span class='const'>InOut</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='symbol'>:write</span> <span class='rparen'>)</span>
680
+ <span class='kw'>end</span></pre>
681
+ </td>
682
+ </tr>
683
+ </table>
684
+ </div>
685
+
686
+ </div>
687
+
688
+ <div id="instance_method_details" class="method_details_list">
689
+ <h2>Instance Method Details</h2>
690
+
691
+
692
+ <div class="method_details first">
693
+ <h3 class="signature first" id="branch-instance_method">
694
+
695
+ - (<tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>) <strong>branch</strong>(fileid)
696
+
697
+
698
+
699
+
700
+
701
+ </h3><div class="docstring">
702
+ <div class="discussion">
703
+
704
+ <p>Attach a file to existing Write stream i.e. writes to Write will be
705
+ directed to attached file as well.</p>
706
+
707
+
708
+ </div>
709
+ </div>
710
+ <div class="tags">
711
+ <p class="tag_title">Parameters:</p>
712
+ <ul class="param">
713
+
714
+ <li>
715
+
716
+ <span class='name'>fileid</span>
717
+
718
+
719
+ <span class='type'>(<tt><span class='object_link'><a href="String.html" title="EasyFile::String (class)">String</a></span></tt>, <tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>)</span>
720
+
721
+
722
+
723
+ &mdash;
724
+ <div class='inline'>
725
+ <p>Filename or Write to add branching.</p>
726
+ </div>
727
+
728
+ </li>
729
+
730
+ </ul>
731
+
732
+ <p class="tag_title">Returns:</p>
733
+ <ul class="return">
734
+
735
+ <li>
736
+
737
+
738
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>)</span>
739
+
740
+
741
+
742
+ &mdash;
743
+ <div class='inline'>
744
+ <p>Added peer.</p>
745
+ </div>
746
+
747
+ </li>
748
+
749
+ </ul>
750
+
751
+ </div><table class="source_code">
752
+ <tr>
753
+ <td>
754
+ <pre class="lines">
755
+
756
+
757
+ 543
758
+ 544
759
+ 545
760
+ 546
761
+ 547
762
+ 548
763
+ 549
764
+ 550
765
+ 551
766
+ 552
767
+ 553
768
+ 554
769
+ 555
770
+ 556
771
+ 557
772
+ 558
773
+ 559
774
+ 560
775
+ 561</pre>
776
+ </td>
777
+ <td>
778
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 543</span>
779
+
780
+ <span class='kw'>def</span> <span class='id identifier rubyid_branch'>branch</span><span class='lparen'>(</span> <span class='id identifier rubyid_fileid'>fileid</span> <span class='rparen'>)</span>
781
+
782
+ <span class='kw'>if</span> <span class='id identifier rubyid_fileid'>fileid</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='const'>String</span>
783
+
784
+
785
+ <span class='comment'># Get new IO.
786
+ </span> <span class='id identifier rubyid_fileio'>fileio</span> <span class='op'>=</span> <span class='const'>Write</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span> <span class='id identifier rubyid_fileid'>fileid</span> <span class='rparen'>)</span>
787
+
788
+ <span class='kw'>else</span>
789
+
790
+ <span class='id identifier rubyid_fileio'>fileio</span> <span class='op'>=</span> <span class='id identifier rubyid_fileid'>fileid</span>
791
+
792
+ <span class='kw'>end</span>
793
+
794
+ <span class='comment'># Add if not already included.
795
+ </span> <span class='ivar'>@peers</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_fileio'>fileio</span> <span class='kw'>unless</span> <span class='ivar'>@peers</span><span class='period'>.</span><span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span> <span class='id identifier rubyid_fileio'>fileio</span> <span class='rparen'>)</span>
796
+
797
+ <span class='id identifier rubyid_fileio'>fileio</span>
798
+ <span class='kw'>end</span></pre>
799
+ </td>
800
+ </tr>
801
+ </table>
802
+ </div>
803
+
804
+ <div class="method_details ">
805
+ <h3 class="signature " id="join-instance_method">
806
+
807
+ - (<tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>) <strong>join</strong>(fileid)
808
+
809
+
810
+
811
+
812
+
813
+ </h3><div class="docstring">
814
+ <div class="discussion">
815
+
816
+ <p>Join the given filestream to this stream. After joining the joined stream
817
+ is output to same file as this stream.</p>
818
+
819
+
820
+ </div>
821
+ </div>
822
+ <div class="tags">
823
+ <p class="tag_title">Parameters:</p>
824
+ <ul class="param">
825
+
826
+ <li>
827
+
828
+ <span class='name'>fileid</span>
829
+
830
+
831
+ <span class='type'>(<tt><span class='object_link'><a href="String.html" title="EasyFile::String (class)">String</a></span></tt>, <tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>)</span>
832
+
833
+
834
+
835
+ &mdash;
836
+ <div class='inline'>
837
+ <p>Filename or Write to join.</p>
838
+ </div>
839
+
840
+ </li>
841
+
842
+ </ul>
843
+
844
+ <p class="tag_title">Returns:</p>
845
+ <ul class="return">
846
+
847
+ <li>
848
+
849
+
850
+ <span class='type'>(<tt><span class='object_link'><a href="" title="EasyFile::Write (class)">Write</a></span></tt>)</span>
851
+
852
+
853
+
854
+ &mdash;
855
+ <div class='inline'>
856
+ <p>Joined peer.</p>
857
+ </div>
858
+
859
+ </li>
860
+
861
+ </ul>
862
+
863
+ </div><table class="source_code">
864
+ <tr>
865
+ <td>
866
+ <pre class="lines">
867
+
868
+
869
+ 569
870
+ 570
871
+ 571
872
+ 572
873
+ 573
874
+ 574
875
+ 575
876
+ 576
877
+ 577
878
+ 578
879
+ 579
880
+ 580</pre>
881
+ </td>
882
+ <td>
883
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 569</span>
884
+
885
+ <span class='kw'>def</span> <span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span> <span class='id identifier rubyid_fileid'>fileid</span> <span class='rparen'>)</span>
886
+
887
+ <span class='kw'>if</span> <span class='id identifier rubyid_fileid'>fileid</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='op'>==</span> <span class='const'>String</span>
888
+ <span class='id identifier rubyid_fileio'>fileio</span> <span class='op'>=</span> <span class='const'>Write</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span> <span class='id identifier rubyid_fileid'>fileid</span><span class='comma'>,</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
889
+ <span class='kw'>else</span>
890
+ <span class='id identifier rubyid_fileio'>fileio</span> <span class='op'>=</span> <span class='id identifier rubyid_fileid'>fileid</span>
891
+ <span class='id identifier rubyid_fileio'>fileio</span><span class='period'>.</span><span class='id identifier rubyid_close'>close</span>
892
+ <span class='kw'>end</span>
893
+
894
+ <span class='id identifier rubyid_fileio'>fileio</span><span class='period'>.</span><span class='id identifier rubyid_io'>io</span> <span class='op'>=</span> <span class='ivar'>@io</span>
895
+ <span class='id identifier rubyid_fileio'>fileio</span>
896
+ <span class='kw'>end</span></pre>
897
+ </td>
898
+ </tr>
899
+ </table>
900
+ </div>
901
+
902
+ <div class="method_details ">
903
+ <h3 class="signature " id="puts-instance_method">
904
+
905
+ - (<tt>Object</tt>) <strong>puts</strong>(str)
906
+
907
+
908
+
909
+
910
+
911
+ </h3><div class="docstring">
912
+ <div class="discussion">
913
+
914
+ <p>Write with automatic newline.</p>
915
+
916
+
917
+ </div>
918
+ </div>
919
+ <div class="tags">
920
+
921
+
922
+ </div><table class="source_code">
923
+ <tr>
924
+ <td>
925
+ <pre class="lines">
926
+
927
+
928
+ 532
929
+ 533
930
+ 534
931
+ 535</pre>
932
+ </td>
933
+ <td>
934
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 532</span>
935
+
936
+ <span class='kw'>def</span> <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
937
+ <span class='id identifier rubyid_nl'>nl</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span> <span class='op'>?</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
938
+ <span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>+</span> <span class='id identifier rubyid_nl'>nl</span> <span class='rparen'>)</span>
939
+ <span class='kw'>end</span></pre>
940
+ </td>
941
+ </tr>
942
+ </table>
943
+ </div>
944
+
945
+ <div class="method_details ">
946
+ <h3 class="signature " id="suppress-instance_method">
947
+
948
+ - (<tt>Object</tt>) <strong>suppress</strong>(disable = true)
949
+
950
+
951
+
952
+
953
+
954
+ </h3><div class="docstring">
955
+ <div class="discussion">
956
+
957
+ <p>Suppress stream output.</p>
958
+
959
+
960
+ </div>
961
+ </div>
962
+ <div class="tags">
963
+ <p class="tag_title">Parameters:</p>
964
+ <ul class="param">
965
+
966
+ <li>
967
+
968
+ <span class='name'>disable</span>
969
+
970
+
971
+ <span class='type'>(<tt>Boolean</tt>)</span>
972
+
973
+
974
+ <em class="default">(defaults to: <tt>true</tt>)</em>
975
+
976
+
977
+ &mdash;
978
+ <div class='inline'>
979
+ <p>Disable or enable suppression.</p>
980
+ </div>
981
+
982
+ </li>
983
+
984
+ </ul>
985
+
986
+
987
+ </div><table class="source_code">
988
+ <tr>
989
+ <td>
990
+ <pre class="lines">
991
+
992
+
993
+ 586
994
+ 587
995
+ 588</pre>
996
+ </td>
997
+ <td>
998
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 586</span>
999
+
1000
+ <span class='kw'>def</span> <span class='id identifier rubyid_suppress'>suppress</span><span class='lparen'>(</span> <span class='id identifier rubyid_disable'>disable</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='rparen'>)</span>
1001
+ <span class='ivar'>@enabled</span> <span class='op'>=</span> <span class='op'>!</span><span class='id identifier rubyid_disable'>disable</span>
1002
+ <span class='kw'>end</span></pre>
1003
+ </td>
1004
+ </tr>
1005
+ </table>
1006
+ </div>
1007
+
1008
+ <div class="method_details ">
1009
+ <h3 class="signature " id="write-instance_method">
1010
+
1011
+ - (<tt>Object</tt>) <strong>write</strong>(str)
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+ </h3><div class="docstring">
1018
+ <div class="discussion">
1019
+
1020
+ <p>Write to all IOs.</p>
1021
+
1022
+
1023
+ </div>
1024
+ </div>
1025
+ <div class="tags">
1026
+
1027
+
1028
+ </div><table class="source_code">
1029
+ <tr>
1030
+ <td>
1031
+ <pre class="lines">
1032
+
1033
+
1034
+ 514
1035
+ 515
1036
+ 516
1037
+ 517
1038
+ 518
1039
+ 519
1040
+ 520
1041
+ 521
1042
+ 522
1043
+ 523
1044
+ 524
1045
+ 525
1046
+ 526
1047
+ 527
1048
+ 528</pre>
1049
+ </td>
1050
+ <td>
1051
+ <pre class="code"><span class="info file"># File 'lib/easyfile.rb', line 514</span>
1052
+
1053
+ <span class='kw'>def</span> <span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
1054
+ <span class='kw'>if</span> <span class='ivar'>@enabled</span>
1055
+ <span class='id identifier rubyid_updateLineNumber'>updateLineNumber</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
1056
+ <span class='kw'>if</span> <span class='ivar'>@io</span>
1057
+ <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
1058
+ <span class='ivar'>@io</span><span class='period'>.</span><span class='id identifier rubyid_flush'>flush</span> <span class='kw'>if</span> <span class='ivar'>@flush</span>
1059
+ <span class='kw'>else</span>
1060
+ <span class='comment'># No output with nil stream.
1061
+ </span> <span class='kw'>end</span>
1062
+
1063
+ <span class='ivar'>@peers</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span>
1064
+ <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span><span class='lparen'>(</span> <span class='id identifier rubyid_str'>str</span> <span class='rparen'>)</span>
1065
+ <span class='kw'>end</span>
1066
+ <span class='kw'>end</span>
1067
+ <span class='kw'>end</span></pre>
1068
+ </td>
1069
+ </tr>
1070
+ </table>
1071
+ </div>
1072
+
1073
+ </div>
1074
+
1075
+ </div>
1076
+
1077
+ <div id="footer">
1078
+ Generated on Wed Jan 15 19:29:45 2014 by
1079
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1080
+ 0.8.6.1 (ruby-1.9.3).
1081
+ </div>
1082
+
1083
+ </body>
1084
+ </html>