Codebase list ruby-fxruby / run/3ac7152a-ab2f-4628-b250-ba7cef029b84/upstream docs / Fox / FXStreamError.html
run/3ac7152a-ab2f-4628-b250-ba7cef029b84/upstream

Tree @run/3ac7152a-ab2f-4628-b250-ba7cef029b84/upstream (Download .tar.gz)

FXStreamError.html @run/3ac7152a-ab2f-4628-b250-ba7cef029b84/upstream — raw · history · blame 

  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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Exception: Fox::FXStreamError
  
    &mdash; FXRuby API Documentation
  
</title>

  <link rel="stylesheet" href="../css/style.css" type="text/css" />

  <link rel="stylesheet" href="../css/common.css" type="text/css" />

<script type="text/javascript">
  pathId = "Fox::FXStreamError";
  relpath = '../';
</script>


  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


  </head>
  <body>
    <div class="nav_wrap">
      <iframe id="nav" src="../class_list.html?1"></iframe>
      <div id="resizer"></div>
    </div>

    <div id="main" tabindex="-1">
      <div id="header">
        <div id="menu">
  
    <a href="../_index.html">Index (F)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
     &raquo; 
    <span class="title">FXStreamError</span>
  
</div>

        <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../class_list.html">

        <svg width="24" height="24">
          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
        </svg>
    </a>
  
</div>
        <div class="clear"></div>
      </div>

      <div id="content"><h1>Exception: Fox::FXStreamError
  
  
  
</h1>
<div class="box_info">
  
  <dl>
    <dt>Inherits:</dt>
    <dd>
      <span class="inheritName">StandardError</span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next">StandardError</li>
          
            <li class="next">Fox::FXStreamError</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
    </dd>
  </dl>
  

  
  
  
  
  

  

  
  <dl>
    <dt>Defined in:</dt>
    <dd>lib/fox16/core.rb</dd>
  </dl>
  
</div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    
<p>FXStreamError is the base class for exceptions which can occur when working with FXStream and its subclasses.</p>


  </div>
</div>
<div class="tags">
  

</div><div id="subclasses">
  <h2>Direct Known Subclasses</h2>
  <p class="children"><span class='object_link'><a href="FXStreamAllocError.html" title="Fox::FXStreamAllocError (class)">FXStreamAllocError</a></span>, <span class='object_link'><a href="FXStreamEndError.html" title="Fox::FXStreamEndError (class)">FXStreamEndError</a></span>, <span class='object_link'><a href="FXStreamFailureError.html" title="Fox::FXStreamFailureError (class)">FXStreamFailureError</a></span>, <span class='object_link'><a href="FXStreamFormatError.html" title="Fox::FXStreamFormatError (class)">FXStreamFormatError</a></span>, <span class='object_link'><a href="FXStreamFullError.html" title="Fox::FXStreamFullError (class)">FXStreamFullError</a></span>, <span class='object_link'><a href="FXStreamNoReadError.html" title="Fox::FXStreamNoReadError (class)">FXStreamNoReadError</a></span>, <span class='object_link'><a href="FXStreamNoWriteError.html" title="Fox::FXStreamNoWriteError (class)">FXStreamNoWriteError</a></span>, <span class='object_link'><a href="FXStreamUnknownError.html" title="Fox::FXStreamUnknownError (class)">FXStreamUnknownError</a></span></p>
</div>







  
    <h2>
      Class Method Summary
      <small><a href="#" class="summary_toggle">collapse</a></small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#makeStreamError-class_method" title="makeStreamError (class method)">.<strong>makeStreamError</strong>(status)  &#x21d2; Object </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>
<p>This is a factory method that takes an FXStreamStatus code as its input and returns the appropriate exception class.</p>
</div></span>
  
</li>

      
    </ul>
  


  

  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="makeStreamError-class_method">
  
    .<strong>makeStreamError</strong>(status)  &#x21d2; <tt>Object</tt> 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    
<p>This is a factory method that takes an FXStreamStatus code as its input and returns the appropriate exception class.</p>


  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'lib/fox16/core.rb', line 422</span>

<span class='kw'>def</span> <span class='const'><span class='object_link'><a href="" title="Fox::FXStreamError (class)">FXStreamError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_makeStreamError'>makeStreamError</span><span class='lparen'>(</span><span class='id identifier rubyid_status'>status</span><span class='rparen'>)</span>
  <span class='kw'>case</span> <span class='id identifier rubyid_status'>status</span>
  <span class='kw'>when</span> <span class='const'>FXStreamEnd</span>
    <span class='const'><span class='object_link'><a href="FXStreamEndError.html" title="Fox::FXStreamEndError (class)">FXStreamEndError</a></span></span>
  <span class='kw'>when</span> <span class='const'>FXStreamFull</span>
    <span class='const'><span class='object_link'><a href="FXStreamFullError.html" title="Fox::FXStreamFullError (class)">FXStreamFullError</a></span></span>
  <span class='kw'>when</span> <span class='const'>FXStreamNoWrite</span>
    <span class='const'><span class='object_link'><a href="FXStreamNoWriteError.html" title="Fox::FXStreamNoWriteError (class)">FXStreamNoWriteError</a></span></span>
  <span class='kw'>when</span> <span class='const'>FXStreamNoRead</span>
    <span class='const'><span class='object_link'><a href="FXStreamNoReadError.html" title="Fox::FXStreamNoReadError (class)">FXStreamNoReadError</a></span></span>
  <span class='kw'>when</span> <span class='const'>FXStreamFormat</span>
    <span class='const'><span class='object_link'><a href="FXStreamFormatError.html" title="Fox::FXStreamFormatError (class)">FXStreamFormatError</a></span></span>
  <span class='kw'>when</span> <span class='const'>FXStreamUnknown</span>
    <span class='const'><span class='object_link'><a href="FXStreamUnknownError.html" title="Fox::FXStreamUnknownError (class)">FXStreamUnknownError</a></span></span>
  <span class='kw'>when</span> <span class='const'>FXStreamAlloc</span>
    <span class='const'><span class='object_link'><a href="FXStreamAllocError.html" title="Fox::FXStreamAllocError (class)">FXStreamAllocError</a></span></span>
  <span class='kw'>when</span> <span class='const'>FXStreamFailure</span>
    <span class='const'><span class='object_link'><a href="FXStreamFailureError.html" title="Fox::FXStreamFailureError (class)">FXStreamFailureError</a></span></span>
  <span class='kw'>else</span>
    <span class='const'><span class='object_link'><a href="" title="Fox::FXStreamError (class)">FXStreamError</a></span></span>
  <span class='kw'>end</span>
<span class='kw'>end</span></pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

      <div id="footer">
  Generated on Mon Jan  2 11:48:19 2023 by
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.9.28 (ruby-3.1.2).
</div>

    </div>
  </body>
</html>