deploy: 20f6a2b

Author: sorairolake

book/lib/changelog.html

@@ -15,7 +15,7 @@
 <span class=nav-text>Resources</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../authors.html>List of Authors</a><li class=nav-item data-depth=1><a class=nav-link href=../license.html>License</a></ul></ul></nav></div><div class=nav-panel-explore data-panel=explore><div class=context><span class=title>abcrypt</span>
 <span class=version></span></div><ul class=components><li class="component is-current"><div class=title><a href=../index.html>abcrypt</a></div></ul></div></div></aside></div><main class=article><div class=toolbar role=navigation><button class=nav-toggle></button>
 <a href=../index.html class=home-link></a><nav class=breadcrumbs aria-label=breadcrumbs><ul><li><a href=../index.html>abcrypt</a><li>Library<li><a href=changelog.html>Changelog</a></ul></nav><div class=edit-this-page><a href=https://github.com/sorairolake/abcrypt/edit/HEAD/docs/book/modules/lib/pages/changelog.adoc>Edit this Page</a></div></div><div class=content><aside class="toc sidebar" data-title=Contents data-levels=2><div class=toc-menu></div></aside><article class=doc><h1 class=page>Changelog</h1><div id=preamble><div class=sectionbody><div class=paragraph><p>All notable changes to this project will be documented in this file.</div><div class=paragraph><p>The format is based on <a href=https://keepachangelog.com/>Keep a Changelog</a>, and this
-project adheres to <a href=https://semver.org/>Semantic Versioning</a>.</div></div><div id=toc class=toc><div id=toctitle>Table of Contents</div><ul class=sectlevel1><li><a href=#_0_3_0_2024_02_17>0.3.0 - 2024-02-17</a><ul class=sectlevel2><li><a href=#_added>Added</a><li><a href=#_changed>Changed</a></ul><li><a href=#_0_2_10_2024_01_18>0.2.10 - 2024-01-18</a><ul class=sectlevel2><li><a href=#_changed_2>Changed</a></ul><li><a href=#_0_2_9_2024_01_07>0.2.9 - 2024-01-07</a><ul class=sectlevel2><li><a href=#_changed_3>Changed</a></ul><li><a href=#_0_2_8_2023_12_07>0.2.8 - 2023-12-07</a><ul class=sectlevel2><li><a href=#_changed_4>Changed</a></ul><li><a href=#_0_2_7_2023_11_29>0.2.7 - 2023-11-29</a><ul class=sectlevel2><li><a href=#_changed_5>Changed</a></ul><li><a href=#_0_2_6_2023_11_04>0.2.6 - 2023-11-04</a><ul class=sectlevel2><li><a href=#_added_2>Added</a></ul><li><a href=#_0_2_5_2023_10_02>0.2.5 - 2023-10-02</a><ul class=sectlevel2><li><a href=#_changed_6>Changed</a></ul><li><a href=#_0_2_4_2023_09_29>0.2.4 - 2023-09-29</a><ul class=sectlevel2><li><a href=#_removed>Removed</a></ul><li><a href=#_0_2_3_2023_09_20_yanked>0.2.3 - 2023-09-20 [YANKED]</a><ul class=sectlevel2><li><a href=#_added_3>Added</a><li><a href=#_changed_7>Changed</a></ul><li><a href=#_0_2_2_2023_09_11>0.2.2 - 2023-09-11</a><ul class=sectlevel2><li><a href=#_added_4>Added</a><li><a href=#_changed_8>Changed</a></ul><li><a href=#_0_2_1_2023_09_05>0.2.1 - 2023-09-05</a><ul class=sectlevel2><li><a href=#_changed_9>Changed</a></ul><li><a href=#_0_2_0_2023_09_03>0.2.0 - 2023-09-03</a><ul class=sectlevel2><li><a href=#_added_5>Added</a><li><a href=#_changed_10>Changed</a></ul><li><a href=#_0_1_0_2023_08_25>0.1.0 - 2023-08-25</a><ul class=sectlevel2><li><a href=#_added_6>Added</a></ul></ul></div></div><div class=sect1><h2 id=_0_3_0_2024_02_17><a class=anchor href=#_0_3_0_2024_02_17></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.10...abcrypt-v0.3.0>0.3.0</a> - 2024-02-17</h2><div class=sectionbody><div class=sect2><h3 id=_added><a class=anchor href=#_added></a>Added</h3><div class=ulist><ul><li><p>Add ABNF definition of the file format (<a href=https://github.com/sorairolake/abcrypt/pull/273>#273</a>)</ul></div></div><div class=sect2><h3 id=_changed><a class=anchor href=#_changed></a>Changed</h3><div class=ulist><ul><li><p>Bump MSRV to 1.74.0 (<a href=https://github.com/sorairolake/abcrypt/pull/272>#272</a>)<li><p>Rename Argon2 parameters (<a href=https://github.com/sorairolake/abcrypt/pull/275>#275</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_10_2024_01_18><a class=anchor href=#_0_2_10_2024_01_18></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.9...abcrypt-v0.2.10>0.2.10</a> - 2024-01-18</h2><div class=sectionbody><div class=sect2><h3 id=_changed_2><a class=anchor href=#_changed_2></a>Changed</h3><div class=ulist><ul><li><p>Change copyright notice in <code>LICENSES/MIT.txt</code></ul></div></div></div></div><div class=sect1><h2 id=_0_2_9_2024_01_07><a class=anchor href=#_0_2_9_2024_01_07></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.8...abcrypt-v0.2.9>0.2.9</a> - 2024-01-07</h2><div class=sectionbody><div class=sect2><h3 id=_changed_3><a class=anchor href=#_changed_3></a>Changed</h3><div class=ulist><ul><li><p>Change to use <code>bump-my-version</code></ul></div></div></div></div><div class=sect1><h2 id=_0_2_8_2023_12_07><a class=anchor href=#_0_2_8_2023_12_07></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.7...abcrypt-v0.2.8>0.2.8</a> - 2023-12-07</h2><div class=sectionbody><div class=sect2><h3 id=_changed_4><a class=anchor href=#_changed_4></a>Changed</h3><div class=ulist><ul><li><p>Supports input from stdin and output to a file in the examples
+project adheres to <a href=https://semver.org/>Semantic Versioning</a>.</div></div><div id=toc class=toc><div id=toctitle>Table of Contents</div><ul class=sectlevel1><li><a href=#_0_3_1_2024_02_17>0.3.1 - 2024-02-17</a><ul class=sectlevel2><li><a href=#_fixed>Fixed</a></ul><li><a href=#_0_3_0_2024_02_17>0.3.0 - 2024-02-17</a><ul class=sectlevel2><li><a href=#_added>Added</a><li><a href=#_changed>Changed</a></ul><li><a href=#_0_2_10_2024_01_18>0.2.10 - 2024-01-18</a><ul class=sectlevel2><li><a href=#_changed_2>Changed</a></ul><li><a href=#_0_2_9_2024_01_07>0.2.9 - 2024-01-07</a><ul class=sectlevel2><li><a href=#_changed_3>Changed</a></ul><li><a href=#_0_2_8_2023_12_07>0.2.8 - 2023-12-07</a><ul class=sectlevel2><li><a href=#_changed_4>Changed</a></ul><li><a href=#_0_2_7_2023_11_29>0.2.7 - 2023-11-29</a><ul class=sectlevel2><li><a href=#_changed_5>Changed</a></ul><li><a href=#_0_2_6_2023_11_04>0.2.6 - 2023-11-04</a><ul class=sectlevel2><li><a href=#_added_2>Added</a></ul><li><a href=#_0_2_5_2023_10_02>0.2.5 - 2023-10-02</a><ul class=sectlevel2><li><a href=#_changed_6>Changed</a></ul><li><a href=#_0_2_4_2023_09_29>0.2.4 - 2023-09-29</a><ul class=sectlevel2><li><a href=#_removed>Removed</a></ul><li><a href=#_0_2_3_2023_09_20_yanked>0.2.3 - 2023-09-20 [YANKED]</a><ul class=sectlevel2><li><a href=#_added_3>Added</a><li><a href=#_changed_7>Changed</a></ul><li><a href=#_0_2_2_2023_09_11>0.2.2 - 2023-09-11</a><ul class=sectlevel2><li><a href=#_added_4>Added</a><li><a href=#_changed_8>Changed</a></ul><li><a href=#_0_2_1_2023_09_05>0.2.1 - 2023-09-05</a><ul class=sectlevel2><li><a href=#_changed_9>Changed</a></ul><li><a href=#_0_2_0_2023_09_03>0.2.0 - 2023-09-03</a><ul class=sectlevel2><li><a href=#_added_5>Added</a><li><a href=#_changed_10>Changed</a></ul><li><a href=#_0_1_0_2023_08_25>0.1.0 - 2023-08-25</a><ul class=sectlevel2><li><a href=#_added_6>Added</a></ul></ul></div></div><div class=sect1><h2 id=_0_3_1_2024_02_17><a class=anchor href=#_0_3_1_2024_02_17></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.3.0...abcrypt-v0.3.1>0.3.1</a> - 2024-02-17</h2><div class=sectionbody><div class=sect2><h3 id=_fixed><a class=anchor href=#_fixed></a>Fixed</h3><div class=ulist><ul><li><p>Fix <code>example.path</code> in <code>Cargo.toml</code> (<a href=https://github.com/sorairolake/abcrypt/pull/283>#283</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_3_0_2024_02_17><a class=anchor href=#_0_3_0_2024_02_17></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.10...abcrypt-v0.3.0>0.3.0</a> - 2024-02-17</h2><div class=sectionbody><div class=sect2><h3 id=_added><a class=anchor href=#_added></a>Added</h3><div class=ulist><ul><li><p>Add ABNF definition of the file format (<a href=https://github.com/sorairolake/abcrypt/pull/273>#273</a>)</ul></div></div><div class=sect2><h3 id=_changed><a class=anchor href=#_changed></a>Changed</h3><div class=ulist><ul><li><p>Bump MSRV to 1.74.0 (<a href=https://github.com/sorairolake/abcrypt/pull/272>#272</a>)<li><p>Rename Argon2 parameters (<a href=https://github.com/sorairolake/abcrypt/pull/275>#275</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_10_2024_01_18><a class=anchor href=#_0_2_10_2024_01_18></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.9...abcrypt-v0.2.10>0.2.10</a> - 2024-01-18</h2><div class=sectionbody><div class=sect2><h3 id=_changed_2><a class=anchor href=#_changed_2></a>Changed</h3><div class=ulist><ul><li><p>Change copyright notice in <code>LICENSES/MIT.txt</code></ul></div></div></div></div><div class=sect1><h2 id=_0_2_9_2024_01_07><a class=anchor href=#_0_2_9_2024_01_07></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.8...abcrypt-v0.2.9>0.2.9</a> - 2024-01-07</h2><div class=sectionbody><div class=sect2><h3 id=_changed_3><a class=anchor href=#_changed_3></a>Changed</h3><div class=ulist><ul><li><p>Change to use <code>bump-my-version</code></ul></div></div></div></div><div class=sect1><h2 id=_0_2_8_2023_12_07><a class=anchor href=#_0_2_8_2023_12_07></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.7...abcrypt-v0.2.8>0.2.8</a> - 2023-12-07</h2><div class=sectionbody><div class=sect2><h3 id=_changed_4><a class=anchor href=#_changed_4></a>Changed</h3><div class=ulist><ul><li><p>Supports input from stdin and output to a file in the examples
 (<a href=https://github.com/sorairolake/abcrypt/pull/154>#154</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_7_2023_11_29><a class=anchor href=#_0_2_7_2023_11_29></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.6...abcrypt-v0.2.7>0.2.7</a> - 2023-11-29</h2><div class=sectionbody><div class=sect2><h3 id=_changed_5><a class=anchor href=#_changed_5></a>Changed</h3><div class=ulist><ul><li><p>Bump MSRV to 1.70.0 (<a href=https://github.com/sorairolake/abcrypt/pull/139>#139</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_6_2023_11_04><a class=anchor href=#_0_2_6_2023_11_04></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.5...abcrypt-v0.2.6>0.2.6</a> - 2023-11-04</h2><div class=sectionbody><div class=sect2><h3 id=_added_2><a class=anchor href=#_added_2></a>Added</h3><div class=ulist><ul><li><p>Add serialization support for <code>Params</code> (<a href=https://github.com/sorairolake/abcrypt/pull/122>#122</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_5_2023_10_02><a class=anchor href=#_0_2_5_2023_10_02></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.4...abcrypt-v0.2.5>0.2.5</a> - 2023-10-02</h2><div class=sectionbody><div class=sect2><h3 id=_changed_6><a class=anchor href=#_changed_6></a>Changed</h3><div class=ulist><ul><li><p>Change link to the format specification (<a href=https://github.com/sorairolake/abcrypt/pull/94>#94</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_4_2023_09_29><a class=anchor href=#_0_2_4_2023_09_29></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.3...abcrypt-v0.2.4>0.2.4</a> - 2023-09-29</h2><div class=sectionbody><div class=sect2><h3 id=_removed><a class=anchor href=#_removed></a>Removed</h3><div class=ulist><ul><li><p>Remove <code>Params::default</code> (<a href=https://github.com/sorairolake/abcrypt/pull/81>#81</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_3_2023_09_20_yanked><a class=anchor href=#_0_2_3_2023_09_20_yanked></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.2...abcrypt-v0.2.3>0.2.3</a> - 2023-09-20 [YANKED]</h2><div class=sectionbody><div class=sect2><h3 id=_added_3><a class=anchor href=#_added_3></a>Added</h3><div class=ulist><ul><li><p>Add constants to represent header and tag sizes (<a href=https://github.com/sorairolake/abcrypt/pull/70>#70</a>)</ul></div></div><div class=sect2><h3 id=_changed_7><a class=anchor href=#_changed_7></a>Changed</h3><div class=ulist><ul><li><p>Change the structure of <code>Params</code> (<a href=https://github.com/sorairolake/abcrypt/pull/70>#70</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_2_2023_09_11><a class=anchor href=#_0_2_2_2023_09_11></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.1...abcrypt-v0.2.2>0.2.2</a> - 2023-09-11</h2><div class=sectionbody><div class=sect2><h3 id=_added_4><a class=anchor href=#_added_4></a>Added</h3><div class=ulist><ul><li><p>Add the <code>homepage</code> field to <code>Cargo.toml</code> (<a href=https://github.com/sorairolake/abcrypt/pull/50>#50</a>)<li><p>Add the book (<a href=https://github.com/sorairolake/abcrypt/pull/56>#56</a>)</ul></div></div><div class=sect2><h3 id=_changed_8><a class=anchor href=#_changed_8></a>Changed</h3><div class=ulist><ul><li><p>Rename test file (<a href=https://github.com/sorairolake/abcrypt/pull/52>#52</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_1_2023_09_05><a class=anchor href=#_0_2_1_2023_09_05></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.2.0...abcrypt-v0.2.1>0.2.1</a> - 2023-09-05</h2><div class=sectionbody><div class=sect2><h3 id=_changed_9><a class=anchor href=#_changed_9></a>Changed</h3><div class=ulist><ul><li><p>Change <code>Params::m_cost</code>, <code>Params::t_cost</code> and <code>Params::p_cost</code> to <code>const fn</code>
 (<a href=https://github.com/sorairolake/abcrypt/pull/44>#44</a>)</ul></div></div></div></div><div class=sect1><h2 id=_0_2_0_2023_09_03><a class=anchor href=#_0_2_0_2023_09_03></a><a href=https://github.com/sorairolake/abcrypt/compare/abcrypt-v0.1.0...abcrypt-v0.2.0>0.2.0</a> - 2023-09-03</h2><div class=sectionbody><div class=sect2><h3 id=_added_5><a class=anchor href=#_added_5></a>Added</h3><div class=ulist><ul><li><p>Add a specialized <code>Result</code> type for read and write operations for the abcrypt
 encrypted data format (<a href=https://github.com/sorairolake/abcrypt/pull/21>#21</a>)<li><p>Add convenience functions for using <code>Encryptor</code> and <code>Decryptor</code>

book/lib/usage.html

@@ -15,7 +15,7 @@
 <span class=nav-text>Resources</span><ul class=nav-list><li class=nav-item data-depth=1><a class=nav-link href=../authors.html>List of Authors</a><li class=nav-item data-depth=1><a class=nav-link href=../license.html>License</a></ul></ul></nav></div><div class=nav-panel-explore data-panel=explore><div class=context><span class=title>abcrypt</span>
 <span class=version></span></div><ul class=components><li class="component is-current"><div class=title><a href=../index.html>abcrypt</a></div></ul></div></div></aside></div><main class=article><div class=toolbar role=navigation><button class=nav-toggle></button>
 <a href=../index.html class=home-link></a><nav class=breadcrumbs aria-label=breadcrumbs><ul><li><a href=../index.html>abcrypt</a><li>Library<li><a href=usage.html>Usage</a></ul></nav><div class=edit-this-page><a href=https://github.com/sorairolake/abcrypt/edit/HEAD/docs/book/modules/lib/pages/usage.adoc>Edit this Page</a></div></div><div class=content><aside class="toc sidebar" data-title=Contents data-levels=2><div class=toc-menu></div></aside><article class=doc><h1 class=page>Usage</h1><div id=preamble><div class=sectionbody><div class=listingblock><div class=title>Add this to your <code>Cargo.toml</code></div><div class=content><pre class="highlightjs highlight"><code class="language-toml hljs" data-lang=toml>[dependencies]
-abcrypt = "0.3.0"</code></pre></div></div></div></div><div class=sect1><h2 id=_crate_features><a class=anchor href=#_crate_features></a>Crate features</h2><div class=sectionbody><div class=dlist><dl><dt class=hdlist1><code>alloc</code><dd><p>Enables features that require an allocator. This is enabled by default
+abcrypt = "0.3.1"</code></pre></div></div></div></div><div class=sect1><h2 id=_crate_features><a class=anchor href=#_crate_features></a>Crate features</h2><div class=sectionbody><div class=dlist><dl><dt class=hdlist1><code>alloc</code><dd><p>Enables features that require an allocator. This is enabled by default
 (implied by <code>std</code>).<dt class=hdlist1><code>std</code><dd><p>Enables features that depend on the standard library. This is enabled by
 default.<dt class=hdlist1><code>serde</code><dd><p>Enables serialization support for <code>Params</code>.</dl></div></div></div><div class=sect1><h2 id=_no_std_support><a class=anchor href=#_no_std_support></a><code>no_std</code> support</h2><div class=sectionbody><div class=paragraph><p>This supports <code>no_std</code> mode. Disables the <code>default</code> feature to enable this.</div><div class=paragraph><p>Note that the memory blocks used by Argon2 when calculating a derived key is
 limited to 256 KiB when the <code>alloc</code> feature is disabled.</div></div></div></article></div></main></div><footer class=footer><p>&copy; 2022&ndash;2024 Shun Sakai &#183; <a href=https://creativecommons.org/licenses/by/4.0/ target=_blank>CC BY 4.0</a><p>Powered by <a href=https://antora.org/ target=_blank>Antora</a> & <a href=https://gitlab.com/antora/antora-ui-default target=_blank>Antora Default UI</a></footer><script id=site-script src=../../_/js/site.js data-ui-root-path=../../_></script><script async src=../../_/js/vendor/highlight.js></script><script src=../../_/js/vendor/lunr.js></script><script src=../../_/js/search-ui.js id=search-ui-script data-site-root-path=../.. data-snippet-length=100 data-stylesheet=../../_/css/search.css></script><script async src=../../search-index.js></script>