-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
41 additions
and
39 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| <!DOCTYPE html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>GroupMetadata (zarr.Zarr.GroupMetadata)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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</a> » <a href="../index.html">Zarr</a> » GroupMetadata</nav><header class="odoc-preamble"><h1>Module <code><span>Zarr.GroupMetadata</span></code></h1><p>A module which contains functionality to work with a parsed JSON Zarr group metadata document.</p></header><div class="odoc-content"><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>A type representing a parsed group metadata document.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Return a group metadata type with default values for all fields.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode"><a href="#val-encode" class="anchor"></a><code><span><span class="keyword">val</span> encode : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>encode t</code> returns a byte string representing a JSON Zarr group metadata.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode"><a href="#val-decode" class="anchor"></a><code><span><span class="keyword">val</span> decode : <span>string <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, <span>[> <span class="xref-unresolved">Zarr__.Metadata.error</span> ]</span>)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>decode s</code> decodes a bytes string <code>s</code> into a <a href="#type-t"><code>t</code></a> type, and returns an error if the decoding process fails.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_attributes"><a href="#val-update_attributes" class="anchor"></a><code><span><span class="keyword">val</span> update_attributes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>update_attributes t json</code> returns a new metadata type with an updated attribute field containing contents in <code>json</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_yojson"><a href="#val-of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> of_yojson : <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>of_yojson json</code> converts a <code>Yojson.Safe.t</code> object into a <a href="#type-t"><code>GroupMetadata.t</code></a> and returns an error message upon failure.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_yojson"><a href="#val-to_yojson" class="anchor"></a><code><span><span class="keyword">val</span> to_yojson : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div><div class="spec-doc"><p><code>to_yojson t</code> serializes a group metadata type into a <code>Yojson.Safe.t</code> object.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-show"><a href="#val-show" class="anchor"></a><code><span><span class="keyword">val</span> show : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>show t</code> pretty-prints the contents of the group metadata type t.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-attributes"><a href="#val-attributes" class="anchor"></a><code><span><span class="keyword">val</span> attributes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div><div class="spec-doc"><p><code>attributes t</code> Returns a Yojson type containing user attributes assigned to the zarr group represented by <code>t</code>.</p></div></div></div></body></html> | ||
| <html xmlns="http://www.w3.org/1999/xhtml"><head><title>GroupMetadata (zarr.Zarr.GroupMetadata)</title><meta charset="utf-8"/><link rel="stylesheet" href="../../../odoc.support/odoc.css"/><meta name="generator" content="odoc 2.4.2"/><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</a> » <a href="../index.html">Zarr</a> » GroupMetadata</nav><header class="odoc-preamble"><h1>Module <code><span>Zarr.GroupMetadata</span></code></h1><p>A module which contains functionality to work with a parsed JSON Zarr group metadata document.</p></header><div class="odoc-content"><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>A type representing a parsed group metadata document.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-default"><a href="#val-default" class="anchor"></a><code><span><span class="keyword">val</span> default : <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p>Return a group metadata type with default values for all fields.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-encode"><a href="#val-encode" class="anchor"></a><code><span><span class="keyword">val</span> encode : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>encode t</code> returns a byte string representing a JSON Zarr group metadata.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-decode"><a href="#val-decode" class="anchor"></a><code><span><span class="keyword">val</span> decode : <span>string <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>decode s</code> decodes a bytes string <code>s</code> into a <a href="#type-t"><code>t</code></a> type, and returns an error if the decoding process fails.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-update_attributes"><a href="#val-update_attributes" class="anchor"></a><code><span><span class="keyword">val</span> update_attributes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <a href="#type-t">t</a></span></code></div><div class="spec-doc"><p><code>update_attributes t json</code> returns a new metadata type with an updated attribute field containing contents in <code>json</code>.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-of_yojson"><a href="#val-of_yojson" class="anchor"></a><code><span><span class="keyword">val</span> of_yojson : <span><span class="xref-unresolved">Yojson</span>.Safe.t <span class="arrow">-></span></span> <span><span>(<a href="#type-t">t</a>, string)</span> <span class="xref-unresolved">Stdlib</span>.result</span></span></code></div><div class="spec-doc"><p><code>of_yojson json</code> converts a <code>Yojson.Safe.t</code> object into a <a href="#type-t"><code>GroupMetadata.t</code></a> and returns an error message upon failure.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-to_yojson"><a href="#val-to_yojson" class="anchor"></a><code><span><span class="keyword">val</span> to_yojson : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div><div class="spec-doc"><p><code>to_yojson t</code> serializes a group metadata type into a <code>Yojson.Safe.t</code> object.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-show"><a href="#val-show" class="anchor"></a><code><span><span class="keyword">val</span> show : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> string</span></code></div><div class="spec-doc"><p><code>show t</code> pretty-prints the contents of the group metadata type t.</p></div></div><div class="odoc-spec"><div class="spec value anchored" id="val-attributes"><a href="#val-attributes" class="anchor"></a><code><span><span class="keyword">val</span> attributes : <span><a href="#type-t">t</a> <span class="arrow">-></span></span> <span class="xref-unresolved">Yojson</span>.Safe.t</span></code></div><div class="spec-doc"><p><code>attributes t</code> Returns a Yojson type containing user attributes assigned to the zarr group represented by <code>t</code>.</p></div></div></div></body></html> |
Oops, something went wrong.