docs/FoundationDB-Layer-Directory.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>FoundationDB.Layer.Directory</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">foundationdb-haskell-0.1.0.0: FoundationDB C client bindings</span><ul class="links" id="page-menu"><li><a href="src/FoundationDB.Layer.Directory.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">FoundationDB.Layer.Directory</p></div><div id="table-of-contents"><div id="contents-list"><p class="caption" onclick="window.scrollTo(0,0)">Contents</p><ul><li><a href="#g:1">Advanced usage</a></li></ul></div></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The directory layer provides tools for creating a
 hierarchy of <code>Subspace</code>s, which can be operated on efficiently with a
 directory-like API. This is one of the official layers supported by all
 language bindings. See the
 <a href="https://apple.github.io/foundationdb/developer-guide.html#directories">official FoundationDB documentation</a>
 for more information.</p><p>This implementation of the directory layer does not yet support directory
 partitions. They will be added in the future.</p></div></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">data</span> <a href="#t:DirectoryLayer">DirectoryLayer</a></li><li class="src short"><a href="#v:defaultDirLayer">defaultDirLayer</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></li><li class="src short"><a href="#v:newDirectoryLayer">newDirectoryLayer</a> :: <a href="FoundationDB-Layer-Subspace.html#t:Subspace" title="FoundationDB.Layer.Subspace">Subspace</a> -&gt; <a href="FoundationDB-Layer-Subspace.html#t:Subspace" title="FoundationDB.Layer.Subspace">Subspace</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></li><li class="src short"><span class="keyword">data</span> <a href="#t:Directory">Directory</a></li><li class="src short"><span class="keyword">type</span> <a href="#t:Path">Path</a> = [<a href="../text-1.2.4.1/Data-Text.html#t:Text" title="Data.Text">Text</a>]</li><li class="src short"><a href="#v:dirSubspace">dirSubspace</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Subspace.html#t:Subspace" title="FoundationDB.Layer.Subspace">Subspace</a></li><li class="src short"><a href="#v:dirPath">dirPath</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a></li><li class="src short"><a href="#v:dirLayer">dirLayer</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a></li><li class="src short"><a href="#v:open">open</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a>)</li><li class="src short"><a href="#v:createOrOpen">createOrOpen</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a></li><li class="src short"><a href="#v:move">move</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="FoundationDB-Layer-Directory-Internal.html#t:MoveError" title="FoundationDB.Layer.Directory.Internal">MoveError</a>)</li><li class="src short"><a href="#v:remove">remove</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></li><li class="src short"><a href="#v:exists">exists</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></li><li class="src short"><a href="#v:list">list</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../containers-0.6.2.1/Data-Sequence.html#t:Seq" title="Data.Sequence">Seq</a> <a href="../text-1.2.4.1/Data-Text.html#t:Text" title="Data.Text">Text</a>)</li><li class="src short"><a href="#v:open-39-">open'</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a> -&gt; <a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a>)</li><li class="src short"><a href="#v:createOrOpen-39-">createOrOpen'</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a> -&gt; <a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a></li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:DirectoryLayer" class="def">DirectoryLayer</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#DirectoryLayer" class="link">Source</a> <a href="#t:DirectoryLayer" class="selflink">#</a></p><div class="doc"><p>Represents a directory tree. A value of this type must be supplied to all
 functions in this module.</p></div><div class="subs instances"><h4 class="instances details-toggle-control details-toggle" data-details-id="i:DirectoryLayer">Instances</h4><details id="i:DirectoryLayer" open="open"><summary class="hide-when-js-enabled">Instances details</summary><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:DirectoryLayer:Eq:1"></span> <a href="../base-4.14.1.0/Data-Eq.html#t:Eq" title="Data.Eq">Eq</a> <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></span> <a href="src/FoundationDB.Layer.Directory.Internal.html#line-49" class="link">Source</a> <a href="#t:DirectoryLayer" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:DirectoryLayer:Eq:1"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="FoundationDB-Layer-Directory-Internal.html">FoundationDB.Layer.Directory.Internal</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></details></td></tr><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:DirectoryLayer:Ord:2"></span> <a href="../base-4.14.1.0/Data-Ord.html#t:Ord" title="Data.Ord">Ord</a> <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></span> <a href="src/FoundationDB.Layer.Directory.Internal.html#line-49" class="link">Source</a> <a href="#t:DirectoryLayer" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:DirectoryLayer:Ord:2"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="FoundationDB-Layer-Directory-Internal.html">FoundationDB.Layer.Directory.Internal</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:compare">compare</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-Ord.html#t:Ordering" title="Data.Ord">Ordering</a> <a href="#v:compare" class="selflink">#</a></p><p class="src"><a href="#v:-60-">(&lt;)</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-60-" class="selflink">#</a></p><p class="src"><a href="#v:-60--61-">(&lt;=)</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-60--61-" class="selflink">#</a></p><p class="src"><a href="#v:-62-">(&gt;)</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-62-" class="selflink">#</a></p><p class="src"><a href="#v:-62--61-">(&gt;=)</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-62--61-" class="selflink">#</a></p><p class="src"><a href="#v:max">max</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> <a href="#v:max" class="selflink">#</a></p><p class="src"><a href="#v:min">min</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> <a href="#v:min" class="selflink">#</a></p></div></details></td></tr><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:DirectoryLayer:Show:3"></span> <a href="../base-4.14.1.0/Text-Show.html#t:Show" title="Text.Show">Show</a> <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></span> <a href="src/FoundationDB.Layer.Directory.Internal.html#line-49" class="link">Source</a> <a href="#t:DirectoryLayer" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:DirectoryLayer:Show:3"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="FoundationDB-Layer-Directory-Internal.html">FoundationDB.Layer.Directory.Internal</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="../base-4.14.1.0/Data-Int.html#t:Int" title="Data.Int">Int</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Text-Show.html#t:ShowS" title="Text.Show">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="../base-4.14.1.0/Data-String.html#t:String" title="Data.String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a>] -&gt; <a href="../base-4.14.1.0/Text-Show.html#t:ShowS" title="Text.Show">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></details></td></tr></table></details></div></div><div class="top"><p class="src"><a id="v:defaultDirLayer" class="def">defaultDirLayer</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#defaultDirLayer" class="link">Source</a> <a href="#v:defaultDirLayer" class="selflink">#</a></p><div class="doc"><p>The default directory layer has node subspace prefix <code>0xfe</code>.
 This corresponds to using the defaults for all arguments to the
 <code>DirectoryLayer</code> constructor in other languages' bindings.</p></div></div><div class="top"><p class="src"><a id="v:newDirectoryLayer" class="def">newDirectoryLayer</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#newDirectoryLayer" class="link">Source</a> <a href="#v:newDirectoryLayer" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="FoundationDB-Layer-Subspace.html#t:Subspace" title="FoundationDB.Layer.Subspace">Subspace</a></td><td class="doc"><p>node subspace for directory metadata</p></td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Layer-Subspace.html#t:Subspace" title="FoundationDB.Layer.Subspace">Subspace</a></td><td class="doc"><p>content subspace</p></td></tr><tr><td class="src">-&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></td><td class="doc"><p>allow manual prefixes</p></td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Creates a new directory layer, containing a  hierarchy of directories.</p></div></div><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Directory" class="def">Directory</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#Directory" class="link">Source</a> <a href="#t:Directory" class="selflink">#</a></p><div class="doc"><p>Represents a single directory.</p></div><div class="subs instances"><h4 class="instances details-toggle-control details-toggle" data-details-id="i:Directory">Instances</h4><details id="i:Directory" open="open"><summary class="hide-when-js-enabled">Instances details</summary><table><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:Directory:Eq:1"></span> <a href="../base-4.14.1.0/Data-Eq.html#t:Eq" title="Data.Eq">Eq</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a></span> <a href="src/FoundationDB.Layer.Directory.Internal.html#line-60" class="link">Source</a> <a href="#t:Directory" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:Directory:Eq:1"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="FoundationDB-Layer-Directory-Internal.html">FoundationDB.Layer.Directory.Internal</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:-61--61-">(==)</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-61--61-" class="selflink">#</a></p><p class="src"><a href="#v:-47--61-">(/=)</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-47--61-" class="selflink">#</a></p></div></details></td></tr><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:Directory:Ord:2"></span> <a href="../base-4.14.1.0/Data-Ord.html#t:Ord" title="Data.Ord">Ord</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a></span> <a href="src/FoundationDB.Layer.Directory.Internal.html#line-60" class="link">Source</a> <a href="#t:Directory" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:Directory:Ord:2"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="FoundationDB-Layer-Directory-Internal.html">FoundationDB.Layer.Directory.Internal</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:compare">compare</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-Ord.html#t:Ordering" title="Data.Ord">Ordering</a> <a href="#v:compare" class="selflink">#</a></p><p class="src"><a href="#v:-60-">(&lt;)</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-60-" class="selflink">#</a></p><p class="src"><a href="#v:-60--61-">(&lt;=)</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-60--61-" class="selflink">#</a></p><p class="src"><a href="#v:-62-">(&gt;)</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-62-" class="selflink">#</a></p><p class="src"><a href="#v:-62--61-">(&gt;=)</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="#v:-62--61-" class="selflink">#</a></p><p class="src"><a href="#v:max">max</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> <a href="#v:max" class="selflink">#</a></p><p class="src"><a href="#v:min">min</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> <a href="#v:min" class="selflink">#</a></p></div></details></td></tr><tr><td class="src clearfix"><span class="inst-left"><span class="instance details-toggle-control details-toggle" data-details-id="i:id:Directory:Show:3"></span> <a href="../base-4.14.1.0/Text-Show.html#t:Show" title="Text.Show">Show</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a></span> <a href="src/FoundationDB.Layer.Directory.Internal.html#line-60" class="link">Source</a> <a href="#t:Directory" class="selflink">#</a></td><td class="doc empty">&nbsp;</td></tr><tr><td colspan="2"><details id="i:id:Directory:Show:3"><summary class="hide-when-js-enabled">Instance details</summary><p>Defined in <a href="FoundationDB-Layer-Directory-Internal.html">FoundationDB.Layer.Directory.Internal</a></p> <div class="subs methods"><p class="caption">Methods</p><p class="src"><a href="#v:showsPrec">showsPrec</a> :: <a href="../base-4.14.1.0/Data-Int.html#t:Int" title="Data.Int">Int</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Text-Show.html#t:ShowS" title="Text.Show">ShowS</a> <a href="#v:showsPrec" class="selflink">#</a></p><p class="src"><a href="#v:show">show</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../base-4.14.1.0/Data-String.html#t:String" title="Data.String">String</a> <a href="#v:show" class="selflink">#</a></p><p class="src"><a href="#v:showList">showList</a> :: [<a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a>] -&gt; <a href="../base-4.14.1.0/Text-Show.html#t:ShowS" title="Text.Show">ShowS</a> <a href="#v:showList" class="selflink">#</a></p></div></details></td></tr></table></details></div></div><div class="top"><p class="src"><span class="keyword">type</span> <a id="t:Path" class="def">Path</a> = [<a href="../text-1.2.4.1/Data-Text.html#t:Text" title="Data.Text">Text</a>] <a href="src/FoundationDB.Layer.Directory.Internal.html#Path" class="link">Source</a> <a href="#t:Path" class="selflink">#</a></p><div class="doc"><p>A path is a list of unicode strings.</p></div></div><div class="top"><p class="src"><a id="v:dirSubspace" class="def">dirSubspace</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Subspace.html#t:Subspace" title="FoundationDB.Layer.Subspace">Subspace</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#dirSubspace" class="link">Source</a> <a href="#v:dirSubspace" class="selflink">#</a></p><div class="doc"><p>Gets the content subspace of a directory, which can be used to store
 tuple-based keys.</p></div></div><div class="top"><p class="src"><a id="v:dirPath" class="def">dirPath</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#dirPath" class="link">Source</a> <a href="#v:dirPath" class="selflink">#</a></p><div class="doc"><p>Gets the path of a directory.</p></div></div><div class="top"><p class="src"><a id="v:dirLayer" class="def">dirLayer</a> :: <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> -&gt; <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#dirLayer" class="link">Source</a> <a href="#v:dirLayer" class="selflink">#</a></p><div class="doc"><p>Gets the layer tag that was specified when the directory was created.</p></div></div><div class="top"><p class="src"><a id="v:open" class="def">open</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a>) <a href="src/FoundationDB.Layer.Directory.Internal.html#open" class="link">Source</a> <a href="#v:open" class="selflink">#</a></p><div class="doc"><p>Tries to open a directory at the given path.
   If the directory exists, returns it. Otherwise, returns <code><a href="../base-4.14.1.0/Data-Maybe.html#v:Nothing" title="Data.Maybe">Nothing</a></code>.</p></div></div><div class="top"><p class="src"><a id="v:createOrOpen" class="def">createOrOpen</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#createOrOpen" class="link">Source</a> <a href="#v:createOrOpen" class="selflink">#</a></p><div class="doc"><p>Opens a directory at the given path. If the directory does not exist, it
 is created.</p></div></div><div class="top"><p class="src"><a id="v:move" class="def">move</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#move" class="link">Source</a> <a href="#v:move" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a></td><td class="doc"><p>from path</p></td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a></td><td class="doc"><p>to path</p></td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="FoundationDB-Layer-Directory-Internal.html#t:MoveError" title="FoundationDB.Layer.Directory.Internal">MoveError</a>)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Move a directory from one path to another. Returns <code>Just err</code> if an error
 occurred. If an error is returned, the directory structure is left
 unchanged.</p></div></div><div class="top"><p class="src"><a id="v:remove" class="def">remove</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#remove" class="link">Source</a> <a href="#v:remove" class="selflink">#</a></p><div class="doc"><p>Remove a directory path, its contents, and all subdirectories.
 Returns <code><a href="../base-4.14.1.0/Data-Bool.html#v:True" title="Data.Bool">True</a></code> if removal succeeds. Fails for nonexistent paths and the root
 directory. In cases of failure, the directory structure is unchanged.</p></div></div><div class="top"><p class="src"><a id="v:exists" class="def">exists</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="../base-4.14.1.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#exists" class="link">Source</a> <a href="#v:exists" class="selflink">#</a></p><div class="doc"><p>Returns <code><a href="../base-4.14.1.0/Data-Bool.html#v:True" title="Data.Bool">True</a></code> iff the given path exists.</p></div></div><div class="top"><p class="src"><a id="v:list" class="def">list</a> :: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a> -&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a> -&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../containers-0.6.2.1/Data-Sequence.html#t:Seq" title="Data.Sequence">Seq</a> <a href="../text-1.2.4.1/Data-Text.html#t:Text" title="Data.Text">Text</a>) <a href="src/FoundationDB.Layer.Directory.Internal.html#list" class="link">Source</a> <a href="#v:list" class="selflink">#</a></p><div class="doc"><p>List the names of the immediate subdirectories of a directory.
 Returns an empty list if the directory does not exist.</p></div></div><a href="#g:1" id="g:1"><h1>Advanced usage</h1></a><div class="top"><p class="src"><a id="v:open-39-" class="def">open'</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#open%27" class="link">Source</a> <a href="#v:open-39-" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a></td><td class="doc"><p>layer</p></td></tr><tr><td class="src">-&gt; <a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a></td><td class="doc"><p>optional custom prefix</p></td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> (<a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a>)</td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Open a directory, with optional custom prefix and layer.
 Returns <code><a href="../base-4.14.1.0/Data-Maybe.html#v:Nothing" title="Data.Maybe">Nothing</a></code> if the directory doesn't exist.</p></div></div><div class="top"><p class="src"><a id="v:createOrOpen-39-" class="def">createOrOpen'</a> <a href="src/FoundationDB.Layer.Directory.Internal.html#createOrOpen%27" class="link">Source</a> <a href="#v:createOrOpen-39-" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="FoundationDB-Layer-Directory.html#t:DirectoryLayer" title="FoundationDB.Layer.Directory">DirectoryLayer</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Layer-Directory.html#t:Path" title="FoundationDB.Layer.Directory">Path</a></td><td class="doc empty">&nbsp;</td></tr><tr><td class="src">-&gt; <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a></td><td class="doc"><p>layer</p></td></tr><tr><td class="src">-&gt; <a href="../base-4.14.1.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="../bytestring-0.10.12.0/Data-ByteString.html#t:ByteString" title="Data.ByteString">ByteString</a></td><td class="doc"><p>optional custom prefix</p></td></tr><tr><td class="src">-&gt; <a href="FoundationDB-Transaction.html#t:Transaction" title="FoundationDB.Transaction">Transaction</a> <a href="FoundationDB-Layer-Directory.html#t:Directory" title="FoundationDB.Layer.Directory">Directory</a></td><td class="doc empty">&nbsp;</td></tr></table></div><div class="doc"><p>Opens a directory at the given path, with optional custom prefix and layer.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.24.0</p></div></body></html>