3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>Class any</title>
5 <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7 <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8 <link rel="up" href="../any/reference.html#header.boost.any_hpp" title="Header <boost/any.hpp>">
9 <link rel="prev" href="bad_any_cast.html" title="Class bad_any_cast">
10 <link rel="next" href="swap_idp41185616.html" title="Function swap">
12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13 <table cellpadding="2" width="100%"><tr>
14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
15 <td align="center"><a href="../../../index.html">Home</a></td>
16 <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19 <td align="center"><a href="../../../more/index.htm">More</a></td>
22 <div class="spirit-nav">
23 <a accesskey="p" href="bad_any_cast.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../any/reference.html#header.boost.any_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_idp41185616.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>
25 <div class="refentry">
26 <a name="boost.any"></a><div class="titlepage"></div>
27 <div class="refnamediv">
28 <h2><span class="refentrytitle">Class any</span></h2>
29 <p>boost::any — A class whose instances can hold instances of any
30 type that satisfies <a class="link" href="../any/reference.html#any.ValueType" title="ValueType requirements">ValueType</a>
33 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
34 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../any/reference.html#header.boost.any_hpp" title="Header <boost/any.hpp>">boost/any.hpp</a>>
37 <span class="keyword">class</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">{</span>
38 <span class="keyword">public</span><span class="special">:</span>
39 <span class="comment">// <a class="link" href="any.html#boost.anyconstruct-copy-destruct">construct/copy/destruct</a></span>
40 <a class="link" href="any.html#idp36966320-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
41 <a class="link" href="any.html#idp36967920-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
42 <a class="link" href="any.html#idp36973232-bb"><span class="identifier">any</span></a><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
43 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a class="link" href="any.html#idp36978784-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
44 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a class="link" href="any.html#idp41337440-bb"><span class="identifier">any</span></a><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
45 <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a class="link" href="any.html#idp41344752-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
46 <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a class="link" href="any.html#idp41351248-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
47 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a class="link" href="any.html#idp41358624-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
48 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a class="link" href="any.html#idp41364720-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span>
49 <a class="link" href="any.html#idp41343184-bb"><span class="special">~</span><span class="identifier">any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
51 <span class="comment">// <a class="link" href="any.html#idp41170944-bb">modifiers</a></span>
52 <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a class="link" href="any.html#idp41171504-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span>
54 <span class="comment">// <a class="link" href="any.html#idp41177296-bb">queries</a></span>
55 <span class="keyword">bool</span> <a class="link" href="any.html#idp41177856-bb"><span class="identifier">empty</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
56 <span class="keyword">const</span> std::type_info <span class="special">&</span> <a class="link" href="any.html#idp41181168-bb"><span class="identifier">type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
57 <span class="special">}</span><span class="special">;</span></pre></div>
58 <div class="refsect1">
59 <a name="idp121082544"></a><h2>Description</h2>
60 <div class="refsect2">
61 <a name="idp121082960"></a><h3>
62 <a name="boost.anyconstruct-copy-destruct"></a><code class="computeroutput">any</code>
64 construct/copy/destruct</h3>
65 <div class="orderedlist"><ol class="orderedlist" type="1">
67 <pre class="literallayout"><a name="idp36966320-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
68 <div class="variablelist"><table border="0" class="variablelist compact">
70 <col align="left" valign="top">
74 <td><p><span class="term">Postconditions:</span></p></td>
75 <td><code class="computeroutput">this-><a class="link" href="any.html#idp41177856-bb">empty</a>()</code></td>
80 <pre class="literallayout"><a name="idp36967920-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>
81 <div class="variablelist"><table border="0" class="variablelist compact">
83 <col align="left" valign="top">
88 <td><p><span class="term">Effects:</span></p></td>
89 <td> Copy constructor that copies content of
90 <code class="computeroutput">other</code> into new instance, so that any content
91 is equivalent in both type and value to the content of
92 <code class="computeroutput">other</code>, or empty if <code class="computeroutput">other</code> is
96 <td><p><span class="term">Throws:</span></p></td>
98 <code class="computeroutput">std::bad_alloc</code>
99 exception or any exceptions arising from the copy
100 constructor of the contained type.</td>
105 <li class="listitem">
106 <pre class="literallayout"><a name="idp36973232-bb"></a><span class="identifier">any</span><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre>
107 <div class="variablelist"><table border="0" class="variablelist compact">
109 <col align="left" valign="top">
114 <td><p><span class="term">Effects:</span></p></td>
115 <td> Move constructor that moves content of
116 <code class="computeroutput">other</code> into new instance and leaves <code class="computeroutput">other</code>
120 <td><p><span class="term">Postconditions:</span></p></td>
121 <td><code class="computeroutput">other-><a class="link" href="any.html#idp41177856-bb">empty</a>()</code></td>
124 <td><p><span class="term">Throws:</span></p></td>
130 <li class="listitem">
131 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a name="idp36978784-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&</span> value<span class="special">)</span><span class="special">;</span></pre>
132 <div class="variablelist"><table border="0" class="variablelist compact">
134 <col align="left" valign="top">
139 <td><p><span class="term">Effects:</span></p></td>
140 <td>Makes a copy of <code class="computeroutput">value</code>, so
141 that the initial content of the new instance is equivalent
142 in both type and value to
143 <code class="computeroutput">value</code>.</td>
146 <td><p><span class="term">Throws:</span></p></td>
148 <code class="computeroutput">std::bad_alloc</code>
149 or any exceptions arising from the copy constructor of the
155 <li class="listitem">
156 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a name="idp41337440-bb"></a><span class="identifier">any</span><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&&</span> value<span class="special">)</span><span class="special">;</span></pre>
157 <div class="variablelist"><table border="0" class="variablelist compact">
159 <col align="left" valign="top">
164 <td><p><span class="term">Effects:</span></p></td>
165 <td>Forwards <code class="computeroutput">value</code>, so
166 that the initial content of the new instance is equivalent
167 in both type and value to
168 <code class="computeroutput">value</code> before the forward.</td>
171 <td><p><span class="term">Throws:</span></p></td>
173 <code class="computeroutput">std::bad_alloc</code>
174 or any exceptions arising from the copy constructor of the
180 <li class="listitem">
181 <pre class="literallayout"><a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a name="idp41344752-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
182 <div class="variablelist"><table border="0" class="variablelist compact">
184 <col align="left" valign="top">
189 <td><p><span class="term">Effects:</span></p></td>
190 <td>Copies content of <code class="computeroutput">rhs</code> into
191 current instance, discarding previous content, so that the
192 new content is equivalent in both type and value to the
193 content of <code class="computeroutput">rhs</code>, or empty if
194 <code class="computeroutput">rhs.<a class="link" href="any.html#idp41177856-bb">empty</a>()</code>.</td>
197 <td><p><span class="term">Throws:</span></p></td>
199 <code class="computeroutput">std::bad_alloc</code>
200 or any exceptions arising from the copy constructor of the
201 contained type. Assignment satisfies the strong guarantee
202 of exception safety.</td>
207 <li class="listitem">
208 <pre class="literallayout"><a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a name="idp41351248-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
209 <div class="variablelist"><table border="0" class="variablelist compact">
211 <col align="left" valign="top">
216 <td><p><span class="term">Effects:</span></p></td>
217 <td>Moves content of <code class="computeroutput">rhs</code> into
218 current instance, discarding previous content, so that the
219 new content is equivalent in both type and value to the
220 content of <code class="computeroutput">rhs</code> before move, or empty if
221 <code class="computeroutput">rhs.<a class="link" href="any.html#idp41177856-bb">empty</a>()</code>.</td>
224 <td><p><span class="term">Postconditions:</span></p></td>
225 <td><code class="computeroutput">rhs-><a class="link" href="any.html#idp41177856-bb">empty</a>()</code></td>
228 <td><p><span class="term">Throws:</span></p></td>
234 <li class="listitem">
235 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a name="idp41358624-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">ValueType</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
236 <div class="variablelist"><table border="0" class="variablelist compact">
238 <col align="left" valign="top">
243 <td><p><span class="term">Effects:</span></p></td>
244 <td>Makes a copy of <code class="computeroutput">rhs</code>,
245 discarding previous content, so that the new content of is
246 equivalent in both type and value to
247 <code class="computeroutput">rhs</code>.</td>
250 <td><p><span class="term">Throws:</span></p></td>
252 <code class="computeroutput">std::bad_alloc</code>
253 or any exceptions arising from the copy constructor of the
254 contained type. Assignment satisfies the strong guarantee
255 of exception safety.</td>
260 <li class="listitem">
261 <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> ValueType<span class="special">></span> <a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a name="idp41364720-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">ValueType</span> <span class="special">&&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
262 <div class="variablelist"><table border="0" class="variablelist compact">
264 <col align="left" valign="top">
269 <td><p><span class="term">Effects:</span></p></td>
270 <td>Forwards <code class="computeroutput">rhs</code>,
271 discarding previous content, so that the new content of is
272 equivalent in both type and value to
273 <code class="computeroutput">rhs</code> before forward.</td>
276 <td><p><span class="term">Throws:</span></p></td>
278 <code class="computeroutput">std::bad_alloc</code>
279 or any exceptions arising from the move or copy constructor of the
280 contained type. Assignment satisfies the strong guarantee
281 of exception safety.</td>
286 <li class="listitem">
287 <pre class="literallayout"><a name="idp41343184-bb"></a><span class="special">~</span><span class="identifier">any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
288 <div class="variablelist"><table border="0" class="variablelist compact">
290 <col align="left" valign="top">
295 <td><p><span class="term">Effects:</span></p></td>
296 <td>Releases any and all resources used in
297 management of instance.</td>
300 <td><p><span class="term">Throws:</span></p></td>
308 <div class="refsect2">
309 <a name="idp121201120"></a><h3>
310 <a name="idp41170944-bb"></a><code class="computeroutput">any</code> modifiers</h3>
311 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
312 <pre class="literallayout"><a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> <a name="idp41171504-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="any.html" title="Class any">any</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre>
313 <div class="variablelist"><table border="0" class="variablelist compact">
315 <col align="left" valign="top">
320 <td><p><span class="term">Effects:</span></p></td>
321 <td>Exchange of the contents of
322 <code class="computeroutput">*this</code> and
323 <code class="computeroutput">rhs</code>.</td>
326 <td><p><span class="term">Returns:</span></p></td>
327 <td><code class="computeroutput">*this</code></td>
330 <td><p><span class="term">Throws:</span></p></td>
337 <div class="refsect2">
338 <a name="idp121214576"></a><h3>
339 <a name="idp41177296-bb"></a><code class="computeroutput">any</code> queries</h3>
340 <div class="orderedlist"><ol class="orderedlist" type="1">
341 <li class="listitem">
342 <pre class="literallayout"><span class="keyword">bool</span> <a name="idp41177856-bb"></a><span class="identifier">empty</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
343 <div class="variablelist"><table border="0" class="variablelist compact">
345 <col align="left" valign="top">
350 <td><p><span class="term">Returns:</span></p></td>
352 <code class="computeroutput">true</code> if instance is
353 empty, otherwise <code class="computeroutput">false</code>.</td>
356 <td><p><span class="term">Throws:</span></p></td>
362 <li class="listitem">
363 <pre class="literallayout"><span class="keyword">const</span> std::type_info <span class="special">&</span> <a name="idp41181168-bb"></a><span class="identifier">type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
364 <div class="variablelist"><table border="0" class="variablelist compact">
366 <col align="left" valign="top">
371 <td><p><span class="term">Returns:</span></p></td>
372 <td>the <code class="computeroutput">typeid</code> of the
373 contained value if instance is non-empty, otherwise
374 <code class="computeroutput">typeid(void)</code>.</td>
377 <td><p><span class="term">Notes:</span></p></td>
378 <td>Useful for querying against types known
379 either at compile time or only at
389 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
390 <td align="left"></td>
391 <td align="right"><div class="copyright-footer">Copyright © 2001 Kevlin Henney<p>Distributed under the Boost Software License, Version 1.0.
392 (See accompanying file <code class="filename">LICENSE_1_0.txt</code> or copy at
393 <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
398 <div class="spirit-nav">
399 <a accesskey="p" href="bad_any_cast.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../any/reference.html#header.boost.any_hpp"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="swap_idp41185616.html"><img src="../../../doc/src/images/next.png" alt="Next"></a>