zarr_codec_zstd

<p>This class provides the codec for "zstd" compression.</p>

The 'Zarr' specification is widely used to build libraries for the storage and retrieval of n-dimensional array data from data stores ranging from local file systems to the cloud. This package is a native 'Zarr' implementation in R with support for all required features of 'Zarr' version 3. It is designed to be extensible such that new stores, codecs and extensions can be added easily.

Patrick Van Laake

zarr

Native and Extensible R Driver for 'Zarr'

zarr_codec_zstd function

<p><code>zarr::zarr_extension</code> -&gt; <code>zarr::zarr_codec</code> -&gt; <code>zarr_codec_zstd</code></p>

Super classes

<p><div class="r6-active-bindings"></div></p><dl>
<dt><code>level</code></dt>
<dd><p>The compression level of the zstd codec, an integer value
between 1L (fast) and 20 (maximum compression).</p></dd><p></p><p>
</p></dl><p></p>

Active bindings


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/zarr_codec_zstd%24new()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_zstd$new()"><code>zarr_codec_zstd$new()</code></a></p></li>
<li><p><a href="/link/zarr_codec_zstd%24copy()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_zstd$copy()"><code>zarr_codec_zstd$copy()</code></a></p></li>
<li><p><a href="/link/zarr_codec_zstd%24encode()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_zstd$encode()"><code>zarr_codec_zstd$encode()</code></a></p></li>
<li><p><a href="/link/zarr_codec_zstd%24decode()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr_codec_zstd$decode()"><code>zarr_codec_zstd$decode()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="metadata_fragment"><a href="/link/zarr%3A%3Azarr_codec%24metadata_fragment()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr::zarr_codec$metadata_fragment()"><code>zarr::zarr_codec$metadata_fragment()</code></a></span></li>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="print"><a href="/link/zarr%3A%3Azarr_codec%24print()?package=zarr&version=0.2.0" data-mini-rdoc="zarr::zarr::zarr_codec$print()"><code>zarr::zarr_codec$print()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-zarr_codec_zstd-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new "zstd" codec object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_zstd$new(configuration = NULL)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>configuration</code></dt>
<dd><p>Optional. A list with the configuration parameters
for this codec. The element <code>level</code> specifies the compression level of
this codec, ranging from 1 (no compression) to 20 (maximum compression).</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>An instance of this class.</p>
</div><p></p><p></p><p><hr>
<a id="method-zarr_codec_zstd-copy"></a></p><div class="section" id="method-copy-">
<h3>Method <code>copy()</code></h3>
<p>Create a new, independent copy of this codec.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_zstd$copy()</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="returns">
<h4>Returns</h4>
<p>An instance of <code>zarr_codec_zstd</code>.</p>
</div></p><p></p><p><hr>
<a id="method-zarr_codec_zstd-encode"></a></p><div class="section" id="method-encode-">
<h3>Method <code>encode()</code></h3>
<p>This method encodes a raw data object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_zstd$encode(data)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>data</code></dt>
<dd><p>The raw data to be encoded.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>The encoded raw data object.</p>
</div><p></p><p></p><p><hr>
<a id="method-zarr_codec_zstd-decode"></a></p><div class="section" id="method-decode-">
<h3>Method <code>decode()</code></h3>
<p>This method decodes a raw data object.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>zarr_codec_zstd$decode(data)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>data</code></dt>
<dd><p>The raw data to be decoded.</p></dd></dl></div></p><p>
</p><p></p>

<div class="section" id="returns">
<h4>Returns</h4>
<p>The decoded raw data object.</p>
</div><p></p><p>
</p>

Methods

Zarr "zstd" codec — zarr_codec_zstd

<p><div class="r6-active-bindings"></p><dl>
<dt><code>level</code></dt>
<dd><p>The compression level of the zstd codec, an integer value
between 1L (fast) and 20 (maximum compression).</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-zarr_codec_zstd-new'><code>zarr_codec_zstd$new()</code></a></p></li>
<li><p><a href='#method-zarr_codec_zstd-copy'><code>zarr_codec_zstd$copy()</code></a></p></li>
<li><p><a href='#method-zarr_codec_zstd-encode'><code>zarr_codec_zstd$encode()</code></a></p></li>
<li><p><a href='#method-zarr_codec_zstd-decode'><code>zarr_codec_zstd$decode()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="metadata_fragment"><a href='../../zarr/html/zarr_codec.html#method-zarr_codec-metadata_fragment'><code>zarr::zarr_codec$metadata_fragment()</code></a></span></li>
<li><span class="pkg-link" data-pkg="zarr" data-topic="zarr_codec" data-id="print"><a href='../../zarr/html/zarr_codec.html#method-zarr_codec-print'><code>zarr::zarr_codec$print()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-zarr_codec_zstd-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new "zstd" codec object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_zstd$new(configuration = NULL)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>configuration</code></dt>
<dd><p>Optional. A list with the configuration parameters
for this codec. The element <code>level</code> specifies the compression level of
this codec, ranging from 1 (no compression) to 20 (maximum compression).</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>An instance of this class.</p>
</div>

</div><p><hr>
<a id="method-zarr_codec_zstd-copy"></a></p><div class='section' id='method-copy-'>
<h3>Method <code>copy()</code></h3>
<p>Create a new, independent copy of this codec.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_zstd$copy()</code></pre><p></div></p>
</div>

<div class='section' id='returns'>
<h4>Returns</h4>
<p>An instance of <code>zarr_codec_zstd</code>.</p>
</div>

</div><p><hr>
<a id="method-zarr_codec_zstd-encode"></a></p><div class='section' id='method-encode-'>
<h3>Method <code>encode()</code></h3>
<p>This method encodes a raw data object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_zstd$encode(data)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>data</code></dt>
<dd><p>The raw data to be encoded.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>The encoded raw data object.</p>
</div>

</div><p><hr>
<a id="method-zarr_codec_zstd-decode"></a></p><div class='section' id='method-decode-'>
<h3>Method <code>decode()</code></h3>
<p>This method decodes a raw data object.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>zarr_codec_zstd$decode(data)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>data</code></dt>
<dd><p>The raw data to be decoded.</p></dd>


</dl><p></div></p>
</div>
<div class='section' id='returns'>
<h4>Returns</h4>
<p>The decoded raw data object.</p>
</div>

</div>


zarr_codec_zstd: Zarr "zstd" codec

Description

Arguments

Super classes

Active bindings

Methods

Public methods

Method `new()`

Usage

Arguments

Returns

Method `copy()`

Usage

Returns

Method `encode()`

Usage

Arguments

Returns

Method `decode()`

Usage

Arguments

Returns

Description

Arguments

Super classes

Active bindings

Methods

Public methods

Method new()

Usage

Arguments

Returns

Method copy()

Usage

Returns

Method encode()

Usage

Arguments

Returns

Method decode()

Usage

Arguments

Returns

Method `new()`

Method `copy()`

Method `encode()`

Method `decode()`