Skip to content

Commit

Permalink
deploy: 764fd2a
Browse files Browse the repository at this point in the history
  • Loading branch information
@zoj613
zoj613 committed Nov 18, 2024
1 parent 762267d commit 00a4d90
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions zarr-lwt/Zarr_lwt/Storage/AmazonS3Store/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>AmazonS3Store (zarr-lwt.Zarr_lwt.Storage.AmazonS3Store)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">zarr-lwt</a> &#x00BB; <a href="../../index.html">Zarr_lwt</a> &#x00BB; <a href="../index.html">Storage</a> &#x00BB; AmazonS3Store</nav><header class="odoc-preamble"><h1>Module <code><span>Storage.AmazonS3Store</span></code></h1><p>An Lwt-aware Amazon S3 bucket storage backend for a Zarr V3 hierarchy.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-S3Error"><a href="#exception-S3Error" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">S3Error</span> <span class="keyword">of</span> <span class="xref-unresolved">Aws_s3_lwt</span>.S3.error</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../../zarr/Zarr/Storage/module-type-STORE/index.html">Zarr.Storage.STORE</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <span>'a <a href="../../../../zarr/Zarr/Storage/module-type-STORE/Deferred/index.html#type-t">Deferred.t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Deferred"><a href="#module-Deferred" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Deferred/index.html">Deferred</a></span><span> : <a href="../../../../zarr/Zarr/Types/module-type-Deferred/index.html">Zarr.Types.Deferred</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <span>'a <a href="../../../../zarr/Zarr/Types/module-type-Deferred/index.html#type-t">t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>The storage type.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Group"><a href="#module-Group" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Group/index.html">Group</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Array"><a href="#module-Array" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Array/index.html">Array</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hierarchy"><a href="#val-hierarchy" class="anchor"></a><code><span><span class="keyword">val</span> hierarchy :
<html xmlns="http://www.w3.org/1999/xhtml"><head><title>AmazonS3Store (zarr-lwt.Zarr_lwt.Storage.AmazonS3Store)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.3"/><meta name="viewport" content="width=device-width,initial-scale=1.0"/><script src="../../../../odoc.support/highlight.pack.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body class="odoc"><nav class="odoc-nav"><a href="../index.html">Up</a> – <a href="../../../index.html">zarr-lwt</a> &#x00BB; <a href="../../index.html">Zarr_lwt</a> &#x00BB; <a href="../index.html">Storage</a> &#x00BB; AmazonS3Store</nav><header class="odoc-preamble"><h1>Module <code><span>Storage.AmazonS3Store</span></code></h1><p>An Lwt-aware Amazon S3 bucket storage backend for a Zarr V3 hierarchy.</p></header><div class="odoc-content"><div class="odoc-spec"><div class="spec exception anchored" id="exception-S3_error"><a href="#exception-S3_error" class="anchor"></a><code><span><span class="keyword">exception</span> </span><span><span class="exception">S3_error</span> <span class="keyword">of</span> <span class="xref-unresolved">Aws_s3_lwt</span>.S3.error</span></code></div></div><div class="odoc-include"><details open="open"><summary class="spec include"><code><span><span class="keyword">include</span> <a href="../../../../zarr/Zarr/Storage/module-type-STORE/index.html">Zarr.Storage.STORE</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <span>'a <a href="../../../../zarr/Zarr/Storage/module-type-STORE/Deferred/index.html#type-t">Deferred.t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></span></code></summary><div class="odoc-spec"><div class="spec module anchored" id="module-Deferred"><a href="#module-Deferred" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Deferred/index.html">Deferred</a></span><span> : <a href="../../../../zarr/Zarr/Types/module-type-Deferred/index.html">Zarr.Types.Deferred</a> <span class="keyword">with</span> <span><span class="keyword">type</span> <span>'a <a href="../../../../zarr/Zarr/Types/module-type-Deferred/index.html#type-t">t</a></span> = <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></span></code></div></div><div class="odoc-spec"><div class="spec type anchored" id="type-t"><a href="#type-t" class="anchor"></a><code><span><span class="keyword">type</span> t</span></code></div><div class="spec-doc"><p>The storage type.</p></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Group"><a href="#module-Group" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Group/index.html">Group</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec module anchored" id="module-Array"><a href="#module-Array" class="anchor"></a><code><span><span class="keyword">module</span> <a href="Array/index.html">Array</a></span><span> : <span class="keyword">sig</span> ... <span class="keyword">end</span></span></code></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-hierarchy"><a href="#val-hierarchy" class="anchor"></a><code><span><span class="keyword">val</span> hierarchy :
<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><a href="../../../../zarr/Zarr/Node/Array/index.html#type-t">Zarr.Node.Array.t</a> list</span> * <span><a href="../../../../zarr/Zarr/Node/Group/index.html#type-t">Zarr.Node.Group.t</a> list</span>)</span> <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>hierarchy t</code> returns <code>p</code> where <code>p</code> is a pair of lists representing all nodes in store <code>t</code>. The first element of the pair is a list of all array nodes, and the second element is a list of all group nodes. This operation returns a pair of empty lists if store <code>t</code> is empty.</p><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <code>Parse_error</code> <p>if any node has invalid <code>node_type</code> metadata.</p></li></ul></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-clear"><a href="#val-clear" class="anchor"></a><code><span><span class="keyword">val</span> clear : <span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span>unit <a href="Deferred/index.html#type-t">Deferred.t</a></span></span></code></div><div class="spec-doc"><p><code>clear t</code> clears the store <code>t</code> by deleting all nodes. If the store is already empty, this is a no-op.</p></div></div></details></div><div class="odoc-spec"><div class="spec value anchored" id="val-with_open"><a href="#val-with_open" class="anchor"></a><code><span><span class="keyword">val</span> with_open :
<span><span class="optlabel">?scheme</span>:<span>[ `Http <span>| `Https</span> ]</span> <span class="arrow">&#45;&gt;</span></span>
Expand All @@ -8,4 +8,4 @@
<span><span class="label">bucket</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span class="label">profile</span>:string <span class="arrow">&#45;&gt;</span></span>
<span><span>(<span><a href="#type-t">t</a> <span class="arrow">&#45;&gt;</span></span> <span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span>)</span> <span class="arrow">&#45;&gt;</span></span>
<span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div></div></div></body></html>
<span><span class="type-var">'a</span> <span class="xref-unresolved">Lwt</span>.t</span></span></code></div><div class="spec-doc"><p><code>with_open ~region ~bucket ~profile f</code> opens an S3 bucket store with bucket name <code>bucket</code> at region <code>region</code> using credentials specified by profile <code>profile</code>. The credentials are read locally from a <code>~/.aws/credentials</code> file or from an IAM service if the profile or file is not available. Function <code>f</code> is applied to the store's open handle and its output is returned to the caller.</p><ul><li><code>scheme</code> is the HTTP scheme to use when connecting to S3, and must be one of <code>`Http | `Https</code>. Defaults to <code>`Http</code>.</li><li><code>inet</code> is the IP version and must be one of <code>`V4 | `V6</code>. Defaults to <code>`V4</code>.</li></ul><ul class="at-tags"><li class="raises"><span class="at-tag">raises</span> <a href="#exception-S3_error"><code>S3_error</code></a> <p>if an error occurs while sending a request to the S3 service.</p></li></ul></div></div></div></body></html>

0 comments on commit 00a4d90

Please sign in to comment.