memory
/
classfoonathan_1_1memory_1_1null__all...

<!-- HTML header for doxygen 1.8.16-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.18"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>memory: null_allocator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">memory
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<div id="main-nav">
    <ul class="sm sm-dox" id="main-menu">
        <li><a href="index.html">Main Page</a></li>
        <li><a href="md_doc_tutorial.html">Tutorial</a></li>
        <li><a href="namespacefoonathan_1_1memory.html">Index</a></li>
        <li><a href="files.html">Files</a></li>
    </ul>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.18 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacefoonathan.html">foonathan</a></li><li class="navelem"><a class="el" href="namespacefoonathan_1_1memory.html">memory</a></li><li class="navelem"><a class="el" href="classfoonathan_1_1memory_1_1null__allocator.html">null_allocator</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">null_allocator Class Reference<div class="ingroups"><a class="el" href="group__allocator.html">Allocator implementations</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A composable <a href="md_doc_concepts.html#concept_rawallocator">RawAllocator</a> that will always fail. </p>
<p>This is useful for compositioning or as last resort in <a class="el" href="classfoonathan_1_1memory_1_1binary__segregator.html">binary_segregator</a>. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Member Functions</h2></td></tr>
<tr class="memitem:ab0976462bc9c4ffc2afeaefbe9f7a72a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1null__allocator.html#ab0976462bc9c4ffc2afeaefbe9f7a72a">allocate_node</a> (std::size_t size, std::size_t)</td></tr>
<tr class="separator:ab0976462bc9c4ffc2afeaefbe9f7a72a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a624e9596c2c5b7d8f9352efc53f42f33"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1null__allocator.html#a624e9596c2c5b7d8f9352efc53f42f33">deallocate_node</a> (void *, std::size_t, std::size_t) noexcept</td></tr>
<tr class="separator:a624e9596c2c5b7d8f9352efc53f42f33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afd462d8916104d036f70cdee790f9f3a"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1null__allocator.html#afd462d8916104d036f70cdee790f9f3a">try_allocate_node</a> (std::size_t, std::size_t) noexcept</td></tr>
<tr class="separator:afd462d8916104d036f70cdee790f9f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a54b8d22ac0d792954827066d16f632"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfoonathan_1_1memory_1_1null__allocator.html#a4a54b8d22ac0d792954827066d16f632">try_deallocate_node</a> (void *, std::size_t, std::size_t) noexcept</td></tr>
<tr class="separator:a4a54b8d22ac0d792954827066d16f632"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Functions</h2>
<a id="ab0976462bc9c4ffc2afeaefbe9f7a72a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0976462bc9c4ffc2afeaefbe9f7a72a">&#9670;&nbsp;</a></span>allocate_node()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void* allocate_node </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Will always throw. </dd></dl>
<dl class="section user"><dt>Throws:</dt><dd>A <a class="el" href="classfoonathan_1_1memory_1_1out__of__fixed__memory.html">out_of_fixed_memory</a> exception. </dd></dl>

</div>
</div>
<a id="a624e9596c2c5b7d8f9352efc53f42f33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a624e9596c2c5b7d8f9352efc53f42f33">&#9670;&nbsp;</a></span>deallocate_node()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void deallocate_node </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Requires:</dt><dd>Must not be called. </dd></dl>

</div>
</div>
<a id="afd462d8916104d036f70cdee790f9f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd462d8916104d036f70cdee790f9f3a">&#9670;&nbsp;</a></span>try_allocate_node()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void* try_allocate_node </td>
          <td>(</td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Does nothing. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>Always returns <code>nullptr</code>. </dd></dl>

</div>
</div>
<a id="a4a54b8d22ac0d792954827066d16f632"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a54b8d22ac0d792954827066d16f632">&#9670;&nbsp;</a></span>try_deallocate_node()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool try_deallocate_node </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">std::size_t&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<dl class="section user"><dt>Effects:</dt><dd>Does nothing. </dd></dl>
<dl class="section user"><dt>Returns:</dt><dd>Always returns <code>false</code>. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.16-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.18
</small></address>
</body>
</html>