doc/html/boost/container/insert_return_type_base.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   5 <title>Struct template insert_return_type_base</title>
   6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
   7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
   9 <link rel="up" href="../../boost_container_header_reference.html#header.boost.container.node_handle_hpp" title="Header &lt;boost/container/node_handle.hpp&gt;">
  10 <link rel="prev" href="node_allocator/rebind.html" title="Struct template rebind">
  11 <link rel="next" href="node_handle.html" title="Class template node_handle">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="node_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.node_handle_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="node_handle.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.container.insert_return_type_base"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Struct template insert_return_type_base</span></h2>
  30 <p>boost::container::insert_return_type_base</p>
  31 </div>
  32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  33 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../boost_container_header_reference.html#header.boost.container.node_handle_hpp" title="Header &lt;boost/container/node_handle.hpp&gt;">boost/container/node_handle.hpp</a>&gt;
  34
  35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> Iterator<span class="special">,</span> <span class="keyword">typename</span> NodeType<span class="special">&gt;</span>
  36 <span class="keyword">struct</span> <a class="link" href="insert_return_type_base.html" title="Struct template insert_return_type_base">insert_return_type_base</a> <span class="special">{</span>
  37   <span class="comment">// <a class="link" href="insert_return_type_base.html#boost.container.insert_return_type_baseconstruct-copy-destruct">construct/copy/destruct</a></span>
  38   <a class="link" href="insert_return_type_base.html#idm45666070311552-bb"><span class="identifier">insert_return_type_base</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  39   <a class="link" href="insert_return_type_base.html#idm45666070311264-bb"><span class="identifier">insert_return_type_base</span></a><span class="special">(</span><a class="link" href="insert_return_type_base.html" title="Struct template insert_return_type_base">insert_return_type_base</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  40   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RelatedIt<span class="special">,</span> <span class="keyword">typename</span> RelatedNode<span class="special">&gt;</span>
  41     <a class="link" href="insert_return_type_base.html#idm45666070310000-bb"><span class="identifier">insert_return_type_base</span></a><span class="special">(</span><span class="keyword">bool</span><span class="special">,</span> <span class="identifier">RelatedIt</span><span class="special">,</span> <span class="identifier">RelatedNode</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  42   <a class="link" href="insert_return_type_base.html" title="Struct template insert_return_type_base">insert_return_type_base</a> <span class="special">&amp;</span> <a class="link" href="insert_return_type_base.html#idm45666070306240-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="insert_return_type_base.html" title="Struct template insert_return_type_base">insert_return_type_base</a> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
  43
  44   <span class="comment">// public data members</span>
  45   <span class="keyword">bool</span> <span class="identifier">inserted</span><span class="special">;</span>
  46   <span class="identifier">Iterator</span> <span class="identifier">position</span><span class="special">;</span>
  47   <span class="identifier">NodeType</span> <span class="identifier">node</span><span class="special">;</span>
  48 <span class="special">}</span><span class="special">;</span></pre></div>
  49 <div class="refsect1">
  50 <a name="id-1.3.10.14.18.3.4"></a><h2>Description</h2>
  51 <p>A class template used to describe the results of inserting a Container::node_type in a Container with unique keys. Includes at least the following non-static public data members:</p>
  52 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  53 <li class="listitem"><p>bool inserted; </p></li>
  54 <li class="listitem"><p>Iterator position; </p></li>
  55 <li class="listitem"><p>NodeType node</p></li>
  56 </ul></div>
  57 <p>
  58 </p>
  59 <p>This type is MoveConstructible, MoveAssignable, DefaultConstructible, Destructible, and lvalues of that type are swappable </p>
  60 <div class="refsect2">
  61 <a name="id-1.3.10.14.18.3.4.5"></a><h3>
  62 <a name="boost.container.insert_return_type_baseconstruct-copy-destruct"></a><code class="computeroutput">insert_return_type_base</code>
  63         public
  64        construct/copy/destruct</h3>
  65 <div class="orderedlist"><ol class="orderedlist" type="1">
  66 <li class="listitem"><pre class="literallayout"><a name="idm45666070311552-bb"></a><span class="identifier">insert_return_type_base</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li>
  67 <li class="listitem"><pre class="literallayout"><a name="idm45666070311264-bb"></a><span class="identifier">insert_return_type_base</span><span class="special">(</span><a class="link" href="insert_return_type_base.html" title="Struct template insert_return_type_base">insert_return_type_base</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  68 <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> RelatedIt<span class="special">,</span> <span class="keyword">typename</span> RelatedNode<span class="special">&gt;</span>
  69   <a name="idm45666070310000-bb"></a><span class="identifier">insert_return_type_base</span><span class="special">(</span><span class="keyword">bool</span> insert<span class="special">,</span> <span class="identifier">RelatedIt</span> it<span class="special">,</span> <span class="identifier">RelatedNode</span> <span class="special">&amp;&amp;</span> node<span class="special">)</span><span class="special">;</span></pre></li>
  70 <li class="listitem"><pre class="literallayout"><a class="link" href="insert_return_type_base.html" title="Struct template insert_return_type_base">insert_return_type_base</a> <span class="special">&amp;</span> <a name="idm45666070306240-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="insert_return_type_base.html" title="Struct template insert_return_type_base">insert_return_type_base</a> <span class="special">&amp;&amp;</span> other<span class="special">)</span><span class="special">;</span></pre></li>
  71 </ol></div>
  72 </div>
  73 </div>
  74 </div>
  75 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  76 <td align="left"></td>
  77 <td align="right"><div class="copyright-footer">Copyright &#169; 2009-2018 Ion Gaztanaga<p>
  78         Distributed under the Boost Software License, Version 1.0. (See accompanying
  79         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  80       </p>
  81 </div></td>
  82 </tr></table>
  83 <hr>
  84 <div class="spirit-nav">
  85 <a accesskey="p" href="node_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_container_header_reference.html#header.boost.container.node_handle_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="node_handle.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  86 </div>
  87 </body>
  88 </html>