levovix
/
Nim
mirrorاز https://github.com/nim-lang/Nim


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507
							<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!--  This file is generated by Nim. -->
<html xmlns="https://www.w3.org/1999/xhtml" xml:lang="en" lang="en" data-theme="auto">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>std/reservedmem</title>

<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>

<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">

<!-- CSS -->
<link rel="stylesheet" type="text/css" href="nimdoc.out.css?v=2.3.1">

<!-- JS -->
<script type="text/javascript" src="dochack.js?v=2.3.1"></script>
</head>
<body>
  <div class="document" id="documentId">
    <div class="container">
      <h1 class="title">std/reservedmem</h1>
      <div class="row">
  <div class="three columns">
    <div class="theme-select-wrapper">
      <label for="theme-select">Theme:&nbsp;</label>
      <select id="theme-select" onchange="setTheme(this.value)">
        <option value="auto">🌗 Match OS</option>
        <option value="dark">🌑 Dark</option>
        <option value="light">🌕 Light</option>
      </select>
    </div>
    <div id="global-links">
      <ul class="simple-boot">
        <li><a href="manual.html">Manual</a></li>
        <li><a href="lib.html">Standard library</a></li>
        <li> <a id="indexLink" href="theindex.html">Index</a></li>
        <li><a href="compiler/theindex.html">Compiler docs</a></li>
        <li><a href="https://nim-lang.github.io/fusion/theindex.html">Fusion docs</a></li>
        <li><a href="https://nim-lang.github.io/Nim/">devel</a>, <a href="https://nim-lang.org/documentation.html">stable</a></li>
      </ul>
    </div>
    <div id="searchInputDiv">
      Search: <input type="search" id="searchInput"
        oninput="search()" />
    </div>
    
    <ul class="simple simple-toc" id="toc-list">
  <li>
  <a class="reference reference-toplevel" href="#6" id="56">Imports</a>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#7" id="57">Types</a></summary>
    <ul class="simple simple-toc-section">
      <li><a class="reference" href="#MemAccessFlags" title="MemAccessFlags = int">MemAccessFlags</a></li>
<li><a class="reference" href="#ReservedMem" title="ReservedMem = object">ReservedMem</a></li>
<li><a class="reference" href="#ReservedMemSeq" title="ReservedMemSeq[T] = object">ReservedMemSeq</a></li>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#9" id="59">Lets</a></summary>
    <ul class="simple simple-toc-section">
      <li><a class="reference" href="#memExec" title="memExec = MemAccessFlags(4'i32)">memExec</a></li>
<li><a class="reference" href="#memExecRead" title="memExecRead = MemAccessFlags(5'i32)">memExecRead</a></li>
<li><a class="reference" href="#memExecReadWrite" title="memExecReadWrite = MemAccessFlags(7'i32)">memExecReadWrite</a></li>
<li><a class="reference" href="#memRead" title="memRead = MemAccessFlags(1'i32)">memRead</a></li>
<li><a class="reference" href="#memReadWrite" title="memReadWrite = MemAccessFlags(3'i32)">memReadWrite</a></li>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#12" id="62">Procs</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">[]
  <li><a class="reference" href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CNatural" title="`[]`[T](s: ReservedMemSeq[T]; pos: Natural): lent T">`[]`[T](s: ReservedMemSeq[T]; pos: Natural): lent T</a></li>
<li><a class="reference" href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CBackwardsIndex" title="`[]`[T](s: ReservedMemSeq[T]; rpos: BackwardsIndex): lent T">`[]`[T](s: ReservedMemSeq[T]; rpos: BackwardsIndex): lent T</a></li>
<li><a class="reference" href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CNatural_2" title="`[]`[T](s: var ReservedMemSeq[T]; pos: Natural): var T">`[]`[T](s: var ReservedMemSeq[T]; pos: Natural): var T</a></li>
<li><a class="reference" href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CBackwardsIndex_2" title="`[]`[T](s: var ReservedMemSeq[T]; rpos: BackwardsIndex): var T">`[]`[T](s: var ReservedMemSeq[T]; rpos: BackwardsIndex): var T</a></li>

</ul>
<ul class="simple nested-toc-section">add
  <li><a class="reference" href="#add%2CReservedMemSeq%5BT%5D%2CT" title="add[T](s: var ReservedMemSeq[T]; val: T)">add[T](s: var ReservedMemSeq[T]; val: T)</a></li>

</ul>
<ul class="simple nested-toc-section">commitedLen
  <li><a class="reference" href="#commitedLen%2CReservedMem" title="commitedLen(m: ReservedMem): int">commitedLen(m: ReservedMem): int</a></li>
<li><a class="reference" href="#commitedLen%2CReservedMemSeq%5BT%5D" title="commitedLen[T](s: ReservedMemSeq[T]): int">commitedLen[T](s: ReservedMemSeq[T]): int</a></li>

</ul>
<ul class="simple nested-toc-section">init
  <li><a class="reference" href="#init%2CtypeReservedMemSeq%2CNatural%2CNatural%2CNatural%2Cint" title="init(SeqType: type ReservedMemSeq; maxLen: Natural; initLen: Natural = 0;
     initCommitLen: Natural = 0; memStart = pointer(nil);
     accessFlags = memReadWrite; maxCommittedAndUnusedPages = 3): SeqType:type">init(SeqType: type ReservedMemSeq; maxLen: Natural; initLen: Natural = 0;
     initCommitLen: Natural = 0; memStart = pointer(nil);
     accessFlags = memReadWrite; maxCommittedAndUnusedPages = 3): SeqType:type</a></li>
<li><a class="reference" href="#init%2CtypeReservedMem%2CNatural%2CNatural%2Cint" title="init(T: type ReservedMem; maxLen: Natural; initLen: Natural = 0;
     initCommitLen = initLen; memStart = pointer(nil);
     accessFlags = memReadWrite; maxCommittedAndUnusedPages = 3): ReservedMem">init(T: type ReservedMem; maxLen: Natural; initLen: Natural = 0;
     initCommitLen = initLen; memStart = pointer(nil);
     accessFlags = memReadWrite; maxCommittedAndUnusedPages = 3): ReservedMem</a></li>

</ul>
<ul class="simple nested-toc-section">len
  <li><a class="reference" href="#len%2CReservedMem" title="len(m: ReservedMem): int">len(m: ReservedMem): int</a></li>
<li><a class="reference" href="#len%2CReservedMemSeq%5BT%5D" title="len[T](s: ReservedMemSeq[T]): int">len[T](s: ReservedMemSeq[T]): int</a></li>

</ul>
<ul class="simple nested-toc-section">maxLen
  <li><a class="reference" href="#maxLen%2CReservedMem" title="maxLen(m: ReservedMem): int">maxLen(m: ReservedMem): int</a></li>
<li><a class="reference" href="#maxLen%2CReservedMemSeq%5BT%5D" title="maxLen[T](s: ReservedMemSeq[T]): int">maxLen[T](s: ReservedMemSeq[T]): int</a></li>

</ul>
<ul class="simple nested-toc-section">pop
  <li><a class="reference" href="#pop%2CReservedMemSeq%5BT%5D" title="pop[T](s: var ReservedMemSeq[T]): T">pop[T](s: var ReservedMemSeq[T]): T</a></li>

</ul>
<ul class="simple nested-toc-section">setLen
  <li><a class="reference" href="#setLen%2CReservedMem%2Cint" title="setLen(m: var ReservedMem; newLen: int)">setLen(m: var ReservedMem; newLen: int)</a></li>
<li><a class="reference" href="#setLen%2CReservedMemSeq%5BT%5D%2Cint" title="setLen[T](s: var ReservedMemSeq[T]; newLen: int)">setLen[T](s: var ReservedMemSeq[T]; newLen: int)</a></li>

</ul>

    </ul>
  </details>
</li>
<li>
  <details open>
    <summary><a class="reference reference-toplevel" href="#18" id="68">Templates</a></summary>
    <ul class="simple simple-toc-section">
      <ul class="simple nested-toc-section">distance
  <li><a class="reference" href="#distance.t%2Cpointer%2Cpointer" title="distance(lhs, rhs: pointer): int">distance(lhs, rhs: pointer): int</a></li>

</ul>
<ul class="simple nested-toc-section">shift
  <li><a class="reference" href="#shift.t%2Cpointer%2Cint" title="shift(p: pointer; distance: int): pointer">shift(p: pointer; distance: int): pointer</a></li>

</ul>

    </ul>
  </details>
</li>

</ul>

  </div>
  <div class="nine columns" id="content">
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L1" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L1" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

    <div id="tocRoot"></div>
    
    <p class="module-desc"><table class="docinfo" frame="void" rules="none"><col class="docinfo-name" /><col class="docinfo-content" /><tbody valign="top"><tr><th class="docinfo-name">Authors:</th><td>Zahary Karadjov</td></tr>
</tbody></table><p>This module provides utilities for reserving portions of the address space of a program without consuming physical memory. It can be used to implement a dynamically resizable buffer that is guaranteed to remain in the same memory location. The buffer will be able to grow up to the size of the initially reserved portion of the address space.</p>
<p>Unstable API.</p>
</p>
    <div class="section" id="6">
  <h1><a class="toc-backref" href="#6">Imports</a></h1>
  <dl class="item">
    <a class="reference external" href="oserrors.html">oserrors</a>, <a class="reference external" href="assertions.html">assertions</a>, <a class="reference external" href="posix.html">posix</a>
  </dl>
</div>
<div class="section" id="7">
  <h1><a class="toc-backref" href="#7">Types</a></h1>
  <dl class="item">
    <div id="MemAccessFlags">
  <dt><pre><a href="reservedmem.html#MemAccessFlags"><span class="Identifier">MemAccessFlags</span></a> <span class="Other">=</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L33" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L33" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="ReservedMem">
  <dt><pre><a href="reservedmem.html#ReservedMem"><span class="Identifier">ReservedMem</span></a> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L35" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L35" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="ReservedMemSeq">
  <dt><pre><a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span> <span class="Other">=</span> <span class="Keyword">object</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L43" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L43" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

  </dl>
</div>
<div class="section" id="9">
  <h1><a class="toc-backref" href="#9">Lets</a></h1>
  <dl class="item">
    <div id="memExec">
  <dt><pre><a href="reservedmem.html#memExec"><span class="Identifier">memExec</span></a> <span class="Other">=</span> <a href="reservedmem.html#MemAccessFlags"><span class="Identifier">MemAccessFlags</span></a><span class="Other">(</span><span class="DecNumber">4'i32</span><span class="Other">)</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L77" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L77" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="memExecRead">
  <dt><pre><a href="reservedmem.html#memExecRead"><span class="Identifier">memExecRead</span></a> <span class="Other">=</span> <a href="reservedmem.html#MemAccessFlags"><span class="Identifier">MemAccessFlags</span></a><span class="Other">(</span><span class="DecNumber">5'i32</span><span class="Other">)</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L78" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L78" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="memExecReadWrite">
  <dt><pre><a href="reservedmem.html#memExecReadWrite"><span class="Identifier">memExecReadWrite</span></a> <span class="Other">=</span> <a href="reservedmem.html#MemAccessFlags"><span class="Identifier">MemAccessFlags</span></a><span class="Other">(</span><span class="DecNumber">7'i32</span><span class="Other">)</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L79" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L79" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="memRead">
  <dt><pre><a href="reservedmem.html#memRead"><span class="Identifier">memRead</span></a> <span class="Other">=</span> <a href="reservedmem.html#MemAccessFlags"><span class="Identifier">MemAccessFlags</span></a><span class="Other">(</span><span class="DecNumber">1'i32</span><span class="Other">)</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L80" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L80" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="memReadWrite">
  <dt><pre><a href="reservedmem.html#memReadWrite"><span class="Identifier">memReadWrite</span></a> <span class="Other">=</span> <a href="reservedmem.html#MemAccessFlags"><span class="Identifier">MemAccessFlags</span></a><span class="Other">(</span><span class="DecNumber">3'i32</span><span class="Other">)</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L81" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L81" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

  </dl>
</div>
<div class="section" id="12">
  <h1><a class="toc-backref" href="#12">Procs</a></h1>
  <dl class="item">
    <div id="[]-procs-all">
  <div id="[],ReservedMemSeq[T],Natural">
  <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CNatural"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#lent"><span class="Identifier">lent</span></a> <span class="Identifier">T</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L190" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L190" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="[],ReservedMemSeq[T],BackwardsIndex">
  <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CBackwardsIndex"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">rpos</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#lent"><span class="Identifier">lent</span></a> <span class="Identifier">T</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L200" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L200" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="[],ReservedMemSeq[T],Natural_2">
  <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CNatural_2"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">pos</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L195" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L195" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="[],ReservedMemSeq[T],BackwardsIndex_2">
  <dt><pre><span class="Keyword">func</span> <a href="#%5B%5D%2CReservedMemSeq%5BT%5D%2CBackwardsIndex_2"><span class="Identifier">`[]`</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">rpos</span><span class="Other">:</span> <a href="system.html#BackwardsIndex"><span class="Identifier">BackwardsIndex</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Keyword">var</span> <span class="Identifier">T</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L203" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L203" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="add-procs-all">
  <div id="add,ReservedMemSeq[T],T">
  <dt><pre><span class="Keyword">proc</span> <a href="#add%2CReservedMemSeq%5BT%5D%2CT"><span class="Identifier">add</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">val</span><span class="Other">:</span> <span class="Identifier">T</span><span class="Other">)</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L213" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L213" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="commitedLen-procs-all">
  <div id="commitedLen,ReservedMem">
  <dt><pre><span class="Keyword">func</span> <a href="#commitedLen%2CReservedMem"><span class="Identifier">commitedLen</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMem"><span class="Identifier">ReservedMem</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L141" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L141" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="commitedLen,ReservedMemSeq[T]">
  <dt><pre><span class="Keyword">func</span> <a href="#commitedLen%2CReservedMemSeq%5BT%5D"><span class="Identifier">commitedLen</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L224" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L224" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="init-procs-all">
  <div id="init,typeReservedMemSeq,Natural,Natural,Natural,int">
  <dt><pre><span class="Keyword">proc</span> <a href="#init%2CtypeReservedMemSeq%2CNatural%2CNatural%2CNatural%2Cint"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">SeqType</span><span class="Other">:</span> <span class="Keyword">type</span> <span class="Identifier">ReservedMemSeq</span><span class="Other">;</span> <span class="Identifier">maxLen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">initLen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span>
          <span class="Identifier">initCommitLen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span> <span class="Identifier">memStart</span> <span class="Other">=</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">(</span><span class="Keyword">nil</span><span class="Other">)</span><span class="Other">;</span>
          <span class="Identifier">accessFlags</span> <span class="Other">=</span> <span class="Identifier">memReadWrite</span><span class="Other">;</span> <span class="Identifier">maxCommittedAndUnusedPages</span> <span class="Other">=</span> <span class="DecNumber">3</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">SeqType:type</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L175" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L175" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="init,typeReservedMem,Natural,Natural,int">
  <dt><pre><span class="Keyword">proc</span> <a href="#init%2CtypeReservedMem%2CNatural%2CNatural%2Cint"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">T</span><span class="Other">:</span> <span class="Keyword">type</span> <span class="Identifier">ReservedMem</span><span class="Other">;</span> <span class="Identifier">maxLen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a><span class="Other">;</span> <span class="Identifier">initLen</span><span class="Other">:</span> <a href="system.html#Natural"><span class="Identifier">Natural</span></a> <span class="Other">=</span> <span class="DecNumber">0</span><span class="Other">;</span>
          <span class="Identifier">initCommitLen</span> <span class="Other">=</span> <span class="Identifier">initLen</span><span class="Other">;</span> <span class="Identifier">memStart</span> <span class="Other">=</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">(</span><span class="Keyword">nil</span><span class="Other">)</span><span class="Other">;</span>
          <span class="Identifier">accessFlags</span> <span class="Other">=</span> <span class="Identifier">memReadWrite</span><span class="Other">;</span> <span class="Identifier">maxCommittedAndUnusedPages</span> <span class="Other">=</span> <span class="DecNumber">3</span><span class="Other">)</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMem"><span class="Identifier">ReservedMem</span></a></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L105" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L105" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="len-procs-all">
  <div id="len,ReservedMem">
  <dt><pre><span class="Keyword">func</span> <a href="#len%2CReservedMem"><span class="Identifier">len</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMem"><span class="Identifier">ReservedMem</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L138" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L138" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="len,ReservedMemSeq[T]">
  <dt><pre><span class="Keyword">func</span> <a href="#len%2CReservedMemSeq%5BT%5D"><span class="Identifier">len</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L206" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L206" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="maxLen-procs-all">
  <div id="maxLen,ReservedMem">
  <dt><pre><span class="Keyword">func</span> <a href="#maxLen%2CReservedMem"><span class="Identifier">maxLen</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMem"><span class="Identifier">ReservedMem</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L144" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L144" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="maxLen,ReservedMemSeq[T]">
  <dt><pre><span class="Keyword">func</span> <a href="#maxLen%2CReservedMemSeq%5BT%5D"><span class="Identifier">maxLen</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L227" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L227" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="pop-procs-all">
  <div id="pop,ReservedMemSeq[T]">
  <dt><pre><span class="Keyword">proc</span> <a href="#pop%2CReservedMemSeq%5BT%5D"><span class="Identifier">pop</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">T</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L218" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L218" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="setLen-procs-all">
  <div id="setLen,ReservedMem,int">
  <dt><pre><span class="Keyword">proc</span> <a href="#setLen%2CReservedMem%2Cint"><span class="Identifier">setLen</span></a><span class="Other">(</span><span class="Identifier">m</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="reservedmem.html#ReservedMem"><span class="Identifier">ReservedMem</span></a><span class="Other">;</span> <span class="Identifier">newLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span> {.<span><span class="Other pragmadots">...</span></span><span class="pragmawrap"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">OSError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span>
    <span class="Identifier">forbids</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span>.}</pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L147" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L147" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>
<div id="setLen,ReservedMemSeq[T],int">
  <dt><pre><span class="Keyword">proc</span> <a href="#setLen%2CReservedMemSeq%5BT%5D%2Cint"><span class="Identifier">setLen</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">(</span><span class="Identifier">s</span><span class="Other">:</span> <span class="Keyword">var</span> <a href="reservedmem.html#ReservedMemSeq"><span class="Identifier">ReservedMemSeq</span></a><span class="Other">[</span><span class="Identifier">T</span><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">newLen</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L209" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L209" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>

  </dl>
</div>
<div class="section" id="18">
  <h1><a class="toc-backref" href="#18">Templates</a></h1>
  <dl class="item">
    <div id="distance-templates-all">
  <div id="distance.t,pointer,pointer">
  <dt><pre><span class="Keyword">template</span> <a href="#distance.t%2Cpointer%2Cpointer"><span class="Identifier">distance</span></a><span class="Other">(</span><span class="Identifier">lhs</span><span class="Other">,</span> <span class="Identifier">rhs</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L26" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L26" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>
<div id="shift-templates-all">
  <div id="shift.t,pointer,int">
  <dt><pre><span class="Keyword">template</span> <a href="#shift.t%2Cpointer%2Cint"><span class="Identifier">shift</span></a><span class="Other">(</span><span class="Identifier">p</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a><span class="Other">;</span> <span class="Identifier">distance</span><span class="Other">:</span> <a href="system.html#int"><span class="Identifier">int</span></a><span class="Other">)</span><span class="Other">:</span> <a href="system.html#pointer"><span class="Identifier">pointer</span></a></pre></dt>
  <dd>
    
    
    <a href="https://github.com/nim-lang/Nim/tree/devel/lib/pure/reservedmem.nim#L29" class="link-seesrc" target="_blank">Source</a>&nbsp;&nbsp;
<a href="https://github.com/nim-lang/Nim/edit/devel/lib/pure/reservedmem.nim#L29" class="link-seesrc" target="_blank" >Edit</a>&nbsp;&nbsp;

  </dd>
</div>

</div>

  </dl>
</div>

  </div>
</div>

      <div class="twelve-columns footer">
        <span class="nim-sprite"></span>
        <br>
        <small style="color: var(--hint);">Made with Nim. Generated: 2025-02-06 22:28:10 UTC</small>
      </div>
    </div>
  </div>
      <script defer data-domain="nim-lang.org" src="https://plausible.io/js/plausible.js"></script>
    
</body>
</html>