Google Git
Sign in
apache / qpid-site / 04beb6e78eda47fdfc2fcfc1d2eeb9a270f89a87 / . / input / releases / qpid-proton-0.32.0 / proton / ruby / api / Qpid / Proton / Types / UniformArray.html
blob: 8984eb7979f2c5d0658f1c55609416cee5582920 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Qpid::Proton::Types::UniformArray
&mdash; Qpid Proton Ruby API
</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 = "Qpid::Proton::Types::UniformArray";
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 (U)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../../Qpid.html" title="Qpid (module)">Qpid</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Proton.html" title="Qpid::Proton (module)">Proton</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Types.html" title="Qpid::Proton::Types (module)">Types</a></span></span>
&raquo;
<span class="title">UniformArray</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>Class: Qpid::Proton::Types::UniformArray
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'>Array</span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'>Array</span></li>
<li class="next">Qpid::Proton::Types::UniformArray</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/types/array.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>*Unsettled API* - An array that is converted to/from an AMQP array of uniform element type. A plain ruby <code>::Array</code> is converted to/from an AMQP list, which can contain mixed type elements. If invalid elements are included, then TypeError will be raised when encoding to AMQP.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#descriptor-instance_method" title="#descriptor (instance method)">#<strong>descriptor</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Optional descriptor.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#type-instance_method" title="#type (instance method)">#<strong>type</strong> &#x21d2; Type </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Array elements must be convertible to this AMQP type.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#<=>-instance_method" title="#&lt;=&gt; (instance method)">#<strong>&lt;=&gt;</strong>(x) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(type, elements = nil, descriptor = nil) &#x21d2; UniformArray </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Construct a uniform array, which will be converted to an AMQP array.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#inspect-instance_method" title="#inspect (instance method)">#<strong>inspect</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public deprecated">
<span class="summary_signature">
<a href="#proton_array_header-instance_method" title="#proton_array_header (instance method)">#<strong>proton_array_header</strong> </a>
</span>
<span class="deprecated note title">deprecated</span>
<span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'>
<p>backwards compatibility <span class='object_link'><a href="" title="Qpid::Proton::Types::UniformArray (class)">UniformArray</a></span></p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(type, elements = nil, descriptor = nil) &#x21d2; <tt><span class='object_link'><a href="" title="Qpid::Proton::Types::UniformArray (class)">UniformArray</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct a uniform array, which will be converted to an AMQP array. A plain ruby <code>::Array</code> is converted to/from an AMQP list, containing mixed type elements.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>type</span>
<span class='type'>(<tt><span class='object_link'><a href="Type.html" title="Qpid::Proton::Types::Type (class)">Type</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>Elements must be convertible to this AMQP type.</p>
</div>
</li>
<li>
<span class='name'>elements</span>
<span class='type'>(<tt>Enumerator</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Initial elements for the array</p>
</div>
</li>
<li>
<span class='name'>descriptor</span>
<span class='type'>(<tt>Object</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
&mdash;
<div class='inline'>
<p>Optional array descriptor</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../ArgumentError.html" title="Qpid::Proton::ArgumentError (class)">ArgumentError</a></span></tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/types/array.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_elements'>elements</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_descriptor'>descriptor</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
<span class='ivar'>@type</span><span class='comma'>,</span> <span class='ivar'>@descriptor</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_descriptor'>descriptor</span>
<span class='ivar'>@proton_array_header</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="../ArgumentError.html" title="Qpid::Proton::ArgumentError (class)">ArgumentError</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>no type specified for array</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='ivar'>@type</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>super</span> <span class='id identifier rubyid_elements'>elements</span> <span class='kw'>if</span> <span class='id identifier rubyid_elements'>elements</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="descriptor-instance_method">
#<strong>descriptor</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Optional descriptor.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>Optional descriptor.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66
67
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/types/array.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_descriptor'>descriptor</span>
<span class='ivar'>@descriptor</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="type-instance_method">
#<strong>type</strong> &#x21d2; <tt><span class='object_link'><a href="Type.html" title="Qpid::Proton::Types::Type (class)">Type</a></span></tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns Array elements must be convertible to this AMQP type.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Type.html" title="Qpid::Proton::Types::Type (class)">Type</a></span></tt>)</span>
&mdash;
<div class='inline'>
<p>Array elements must be convertible to this AMQP type</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/types/array.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
<span class='ivar'>@type</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="<=>-instance_method">
#<strong>&lt;=&gt;</strong>(x)
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
70
71
72
73</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/types/array.rb', line 70</span>
<span class='kw'>def</span> <span class='op'>&lt;=&gt;</span><span class='lparen'>(</span><span class='id identifier rubyid_x'>x</span><span class='rparen'>)</span>
<span class='id identifier rubyid_ret'>ret</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='ivar'>@type</span><span class='comma'>,</span> <span class='ivar'>@descriptor</span><span class='rbracket'>]</span> <span class='op'>&lt;=&gt;</span> <span class='lbracket'>[</span><span class='id identifier rubyid_x'>x</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span><span class='comma'>,</span> <span class='id identifier rubyid_x'>x</span><span class='period'>.</span><span class='id identifier rubyid_descriptor'>descriptor</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_ret'>ret</span> <span class='op'>==</span> <span class='int'>0</span> <span class='op'>?</span> <span class='kw'>super</span> <span class='op'>:</span> <span class='id identifier rubyid_ret'>ret</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="inspect-instance_method">
#<strong>inspect</strong>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/types/array.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_inspect'>inspect</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>&lt;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_type'>type</span><span class='embexpr_end'>}</span><span class='tstring_content'>&gt;</span><span class='embexpr_beg'>#{</span><span class='kw'>super</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="proton_array_header-instance_method">
#<strong>proton_array_header</strong>
</h3><div class="docstring">
<div class="discussion">
<div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>
<p>backwards compatibility <span class='object_link'><a href="" title="Qpid::Proton::Types::UniformArray (class)">Qpid::Proton::Types::UniformArray</a></span></p>
</div></div>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
58
59
60</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/types/array.rb', line 58</span>
<span class='kw'>def</span> <span class='id identifier rubyid_proton_array_header'>proton_array_header</span>
<span class='ivar'>@proton_array_header</span> <span class='op'>||=</span> <span class='const'><span class='object_link'><a href="ArrayHeader.html" title="Qpid::Proton::Types::ArrayHeader (class)">ArrayHeader</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ArrayHeader.html#initialize-instance_method" title="Qpid::Proton::Types::ArrayHeader#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='ivar'>@type</span><span class='comma'>,</span> <span class='ivar'>@descriptor</span><span class='rparen'>)</span> <span class='comment'># Deprecated
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed Nov 11 12:57:52 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.24 (ruby-2.7.2).
</div>
</div>
</body>
</html>