9494129

baioc · Oct 18, 2023 · 6cdf0c4 · 6cdf0c4
commit 6cdf0c4
Show file tree

Hide file tree

Showing 63 changed files with 4,386 additions and 0 deletions.
diff --git a/docs/deps.svg b/docs/deps.svg
diff --git a/docs/eris.allocator.Allocator.alignment.html b/docs/eris.allocator.Allocator.alignment.html
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+        <title>Allocator.alignment (eris.allocator.Allocator.alignment)</title>
+	<meta charset="utf-8" />
+	<meta content="width=device-width, initial-scale=1" name="viewport" />
+        <link href="style.css" rel="stylesheet" />
+        <script src="script.js" type="text/javascript"></script>
+
+
+	<link href="search-results.html" rel="prefetch" />
+</head>
+<body>
+	<div id="page-header">
+		<div id="logotype">
+		<span>Documentation</span>
+		<nav>
+			<a href="http://dlang.org/">Dlang.org</a>
+		</nav>
+		</div>
+
+		<form action="search-docs.html" id="search">
+			<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
+			<input type="submit" value="Go" />
+		</form>
+	</div>
+	<div id="page-body">
+		<div id="page-content">
+		<h1>Allocator.alignment</h1><div class="breadcrumbs"><a class="breadcrumb" href="eris.html">eris</a> <a class="breadcrumb" href="eris.allocator.html">allocator</a> <a class="breadcrumb" href="eris.allocator.Allocator.html">Allocator</a> </div><div><div class="documentation-comment synopsis"><div><p>Minimum alignment of all allocated memory blocks.</p></div></div></div><div class="annotated-prototype"><div class="function-prototype"><div class="parent-prototype"><span class="builtin-type">interface</span> <span class="name">Allocator</span></div><div><div class="attributes">nothrow @<span class="name" data-ident="property">property</span> const </div><div class="return-type"><span class="builtin-type">uint</span></div><div class="function-name">alignment</div><div class="template-parameters" data-count="0"></div><div class="runtime-parameters" data-count="0"><div class="parameters-list toplevel"><span class="paren">(</span><span class="paren">)</span></div></div><div class="function-contracts"><div class="out-contract">out (a; a &gt; 0 &amp;&amp; a.isPowerOf2)</div></div></div></div></div><div></div></div>
+		<div id="page-nav"><a class="parent" href="eris.html">eris</a> <a class="parent" href="eris.allocator.html">allocator</a> <a class="parent" href="eris.allocator.Allocator.html">Allocator</a> 
+		<span class="type-separator">functions</span><ul><li><a class="function" href="eris.allocator.Allocator.allocate.html">allocate</a></li><li><a class="function" href="eris.allocator.Allocator.deallocate.html">deallocate</a></li></ul><span class="type-separator">properties</span><ul><li><a class="property current" href="eris.allocator.Allocator.alignment.html">alignment</a></li></ul></div>
+	</div>
+	<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
+</body>
+</html>
diff --git a/docs/eris.allocator.Allocator.allocate.html b/docs/eris.allocator.Allocator.allocate.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+        <title>Allocator.allocate (eris.allocator.Allocator.allocate)</title>
+	<meta charset="utf-8" />
+	<meta content="width=device-width, initial-scale=1" name="viewport" />
+        <link href="style.css" rel="stylesheet" />
+        <script src="script.js" type="text/javascript"></script>
+
+
+	<link href="search-results.html" rel="prefetch" />
+</head>
+<body>
+	<div id="page-header">
+		<div id="logotype">
+		<span>Documentation</span>
+		<nav>
+			<a href="http://dlang.org/">Dlang.org</a>
+		</nav>
+		</div>
+
+		<form action="search-docs.html" id="search">
+			<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
+			<input type="submit" value="Go" />
+		</form>
+	</div>
+	<div id="page-body">
+		<div id="page-content">
+		<h1>Allocator.allocate</h1><div class="breadcrumbs"><a class="breadcrumb" href="eris.html">eris</a> <a class="breadcrumb" href="eris.allocator.html">allocator</a> <a class="breadcrumb" href="eris.allocator.Allocator.html">Allocator</a> </div><div><div class="documentation-comment synopsis"><div><p>Attempts to allocate a memory block of <tt class="inline-code">size</tt> bytes.</p><p>If <tt class="inline-code">size == 0</tt>, the returned slice might have a null <tt class="inline-code">.ptr</tt>, but either way
+		it can be safely <a class="xref" href="eris.allocator.Allocator.deallocate.html">deallocate</a>d.</p></div></div></div><div class="annotated-prototype"><div class="function-prototype"><div class="parent-prototype"><span class="builtin-type">interface</span> <span class="name">Allocator</span></div><div><div class="attributes">nothrow </div><div class="return-type"><span class="builtin-type">void</span>[]</div><div class="function-name">allocate</div><div class="template-parameters" data-count="0"></div><div class="runtime-parameters" data-count="1"><div class="parameters-list toplevel"><span class="paren">(</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="name" data-ident="size_t">size_t</span></span></span> <span class="parameter-name name" data-ident="size"><a href="#param-size">size</a></span></div><span class="paren">)</span></div></div><div class="function-contracts"><div class="out-contract">out (mem; mem.ptr == null || mem.length == size)</div></div></div></div></div><div><h2 id="returns"><a class="header-anchor" href="#returns">Return Value</a></h2><div><div class="return-type-holder">Type: <span class="return-type"><span class="builtin-type">void</span>[]</span></div><div class="documentation-comment returns-description"><div><p>The allocated memory block, or null on allocation failure.</p></div></div></div></div></div>
+		<div id="page-nav"><a class="parent" href="eris.html">eris</a> <a class="parent" href="eris.allocator.html">allocator</a> <a class="parent" href="eris.allocator.Allocator.html">Allocator</a> 
+		<span class="type-separator">functions</span><ul><li><a class="function current" href="eris.allocator.Allocator.allocate.html">allocate</a></li><li><a class="function" href="eris.allocator.Allocator.deallocate.html">deallocate</a></li></ul><span class="type-separator">properties</span><ul><li><a class="property" href="eris.allocator.Allocator.alignment.html">alignment</a></li></ul></div>
+	</div>
+	<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
+</body>
+</html>
diff --git a/docs/eris.allocator.Allocator.deallocate.html b/docs/eris.allocator.Allocator.deallocate.html
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+        <title>Allocator.deallocate (eris.allocator.Allocator.deallocate)</title>
+	<meta charset="utf-8" />
+	<meta content="width=device-width, initial-scale=1" name="viewport" />
+        <link href="style.css" rel="stylesheet" />
+        <script src="script.js" type="text/javascript"></script>
+
+
+	<link href="search-results.html" rel="prefetch" />
+</head>
+<body>
+	<div id="page-header">
+		<div id="logotype">
+		<span>Documentation</span>
+		<nav>
+			<a href="http://dlang.org/">Dlang.org</a>
+		</nav>
+		</div>
+
+		<form action="search-docs.html" id="search">
+			<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
+			<input type="submit" value="Go" />
+		</form>
+	</div>
+	<div id="page-body">
+		<div id="page-content">
+		<h1>Allocator.deallocate</h1><div class="breadcrumbs"><a class="breadcrumb" href="eris.html">eris</a> <a class="breadcrumb" href="eris.allocator.html">allocator</a> <a class="breadcrumb" href="eris.allocator.Allocator.html">Allocator</a> </div><div><div class="documentation-comment synopsis"><div><p>Deallocates a previously-allocated memory block.</p><p>NOTE: Unlike in std.experimental.allocator, this method does not have to return anything.</p></div></div></div><div class="annotated-prototype"><div class="function-prototype"><div class="parent-prototype"><span class="builtin-type">interface</span> <span class="name">Allocator</span></div><div><div class="attributes">nothrow </div><div class="return-type"><span class="builtin-type">void</span></div><div class="function-name">deallocate</div><div class="template-parameters" data-count="0"></div><div class="runtime-parameters" data-count="1"><div class="parameters-list toplevel"><span class="paren">(</span><div class="runtime-parameter-item parameter-item"><span class="parameter-type-holder"><span class="parameter-type"><span class="builtin-type">void</span>[]</span></span> <span class="parameter-name name" data-ident="memory"><a href="#param-memory">memory</a></span></div><span class="paren">)</span></div></div></div></div></div><div></div></div>
+		<div id="page-nav"><a class="parent" href="eris.html">eris</a> <a class="parent" href="eris.allocator.html">allocator</a> <a class="parent" href="eris.allocator.Allocator.html">Allocator</a> 
+		<span class="type-separator">functions</span><ul><li><a class="function" href="eris.allocator.Allocator.allocate.html">allocate</a></li><li><a class="function current" href="eris.allocator.Allocator.deallocate.html">deallocate</a></li></ul><span class="type-separator">properties</span><ul><li><a class="property" href="eris.allocator.Allocator.alignment.html">alignment</a></li></ul></div>
+	</div>
+	<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
+</body>
+</html>
diff --git a/docs/eris.allocator.Allocator.html b/docs/eris.allocator.Allocator.html
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+        <title>Allocator (eris.allocator.Allocator)</title>
+	<meta charset="utf-8" />
+	<meta content="width=device-width, initial-scale=1" name="viewport" />
+        <link href="style.css" rel="stylesheet" />
+        <script src="script.js" type="text/javascript"></script>
+
+
+	<link href="search-results.html" rel="prefetch" />
+</head>
+<body>
+	<div id="page-header">
+		<div id="logotype">
+		<span>Documentation</span>
+		<nav>
+			<a href="http://dlang.org/">Dlang.org</a>
+		</nav>
+		</div>
+
+		<form action="search-docs.html" id="search">
+			<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
+			<input type="submit" value="Go" />
+		</form>
+	</div>
+	<div id="page-body">
+		<div id="page-content">
+		<h1>Allocator</h1><div class="breadcrumbs"><a class="breadcrumb" href="eris.html">eris</a> <a class="breadcrumb" href="eris.allocator.html">allocator</a> </div><div><div class="documentation-comment synopsis"><div><p>Base allocator interface.</p><p>All memory obtained with <tt class="inline-code">allocate</tt> must be disposed by <tt class="inline-code">deallocate</tt> on the same allocator instance.</p><p>NOTE: Unlike <a href="https://dlang.org/phobos/std_experimental_allocator_building_blocks.html">std.experimental.allocator</a>,
+	we always require a deallocation procedure.</p></div></div></div><div class="annotated-prototype"><div class="aggregate-prototype"><div class="attributes"><div class="versions-container">version(!D_BetterC)</div></div><span class="builtin-type">interface</span> Allocator  {<div class="aggregate-member"><a href="eris.allocator.Allocator.allocate.html"><tt class="highlighted"><span class="type">void</span>[]</tt> <span class="name">allocate</span>(size_t size);</a></div><div class="aggregate-member"><a href="eris.allocator.Allocator.deallocate.html"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">deallocate</span>(void[] memory);</a></div><div class="aggregate-member"><a href="eris.allocator.Allocator.alignment.html"><tt class="highlighted"><span class="type">uint</span></tt> <span class="name">alignment</span> [@property getter];</a></div>}</div></div><h2 id="members"><a class="header-anchor" href="#members">Members</a></h2><h3 class="member-list-header hide-from-toc" id="function"><a class="header-anchor" href="#function">Functions</a></h3><dl class="member-list native"><dt><a href="eris.allocator.Allocator.allocate.html">allocate</a><div class="simplified-prototype" style="max-width: 30ch;"><tt class="highlighted"><span class="type">void</span>[]</tt> <span class="name">allocate</span>(size_t size)</div></dt><dd><div><p>Attempts to allocate a memory block of <tt class="inline-code">size</tt> bytes.</p></div></dd><dt><a href="eris.allocator.Allocator.deallocate.html">deallocate</a><div class="simplified-prototype" style="max-width: 33ch;"><tt class="highlighted"><span class="type">void</span></tt> <span class="name">deallocate</span>(void[] memory)</div></dt><dd><div><p>Deallocates a previously-allocated memory block.</p></div></dd></dl><h3 class="member-list-header hide-from-toc" id="property"><a class="header-anchor" href="#property">Properties</a></h3><dl class="member-list native"><dt><a href="eris.allocator.Allocator.alignment.html">alignment</a><div class="simplified-prototype" style="max-width: 36ch;"><tt class="highlighted"><span class="type">uint</span></tt> <span class="name">alignment</span> [@property getter]</div></dt><dd><div><p>Minimum alignment of all allocated memory blocks.</p></div></dd></dl><div></div></div>
+		<div id="page-nav"><a class="parent" href="eris.html">eris</a> <a class="parent" href="eris.allocator.html">allocator</a> 
+		<span class="type-separator">functions</span><ul><li><a class="function" href="eris.allocator.dispose.1.html">dispose</a></li><li><a class="function" href="eris.allocator.make.html">make</a></li><li><a class="function" href="eris.allocator.makeArray.html">makeArray</a></li></ul><span class="type-separator">interfaces</span><ul><li><a class="interface current" href="eris.allocator.Allocator.html">Allocator</a></li></ul><span class="type-separator">structs</span><ul><li><a class="struct" href="eris.allocator.Mallocator.html">Mallocator</a></li></ul><span class="type-separator">variables</span><ul><li><a class="variable" href="eris.allocator.isAllocator.html">isAllocator</a></li><li><a class="variable" href="eris.allocator.platformAlignment.html">platformAlignment</a></li></ul></div>
+	</div>
+	<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
+</body>
+</html>
diff --git a/docs/eris.allocator.Mallocator.html b/docs/eris.allocator.Mallocator.html
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+        <title>Mallocator (eris.allocator.Mallocator)</title>
+	<meta charset="utf-8" />
+	<meta content="width=device-width, initial-scale=1" name="viewport" />
+        <link href="style.css" rel="stylesheet" />
+        <script src="script.js" type="text/javascript"></script>
+
+
+	<link href="search-results.html" rel="prefetch" />
+</head>
+<body>
+	<div id="page-header">
+		<div id="logotype">
+		<span>Documentation</span>
+		<nav>
+			<a href="http://dlang.org/">Dlang.org</a>
+		</nav>
+		</div>
+
+		<form action="search-docs.html" id="search">
+			<input name="searchTerm" placeholder="Find a symbol name..." type="search" />
+			<input type="submit" value="Go" />
+		</form>
+	</div>
+	<div id="page-body">
+		<div id="page-content">
+		<h1>Mallocator</h1><div class="breadcrumbs"><a class="breadcrumb" href="eris.html">eris</a> <a class="breadcrumb" href="eris.allocator.html">allocator</a> </div><div><div class="documentation-comment synopsis"><div><p>C stdlib allocator using malloc and free.</p></div></div></div><div class="annotated-prototype"><div class="aggregate-prototype"><div class="attributes"></div><span class="builtin-type">struct</span> Mallocator  {<div class="aggregate-member"><div class="attributes">pragma(<span class="name" data-ident="inline">inline</span>) nothrow @<span class="name" data-ident="nogc">nogc</span> </div><tt class="highlighted"><span class="kwrd">enum</span></tt> <tt class="highlighted"><span class="type">uint</span></tt> <span class="name">alignment</span>;</div>}</div></div><div></div></div>
+		<div id="page-nav"><a class="parent" href="eris.html">eris</a> <a class="parent" href="eris.allocator.html">allocator</a> 
+		<span class="type-separator">functions</span><ul><li><a class="function" href="eris.allocator.dispose.1.html">dispose</a></li><li><a class="function" href="eris.allocator.make.html">make</a></li><li><a class="function" href="eris.allocator.makeArray.html">makeArray</a></li></ul><span class="type-separator">interfaces</span><ul><li><a class="interface" href="eris.allocator.Allocator.html">Allocator</a></li></ul><span class="type-separator">structs</span><ul><li><a class="struct current" href="eris.allocator.Mallocator.html">Mallocator</a></li></ul><span class="type-separator">variables</span><ul><li><a class="variable" href="eris.allocator.isAllocator.html">isAllocator</a></li><li><a class="variable" href="eris.allocator.platformAlignment.html">platformAlignment</a></li></ul></div>
+	</div>
+	<div id="page-footer">Page generated by <a href="https://github.com/adamdruppe/adrdox">adrdox</a></div>
+</body>
+</html>