build based on f273708

previews/PR55/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-02T19:17:39","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-07-02T19:39:42","documenter_version":"1.5.0"}}

previews/PR55/index.html

@@ -173,4 +173,4 @@
 JuliaCon("JuliaCon 2024", Date("2024-07-22"), Date("2024-07-24"))
 
 julia> to_json(juliacon)
-&quot;{\&quot;title\&quot;:\&quot;JuliaCon 2024\&quot;,\&quot;start_date\&quot;:\&quot;2024-07-22\&quot;,\&quot;end_date\&quot;:\&quot;2024-07-24\&quot;}&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="pages/json/">JSON »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Tuesday 2 July 2024 19:17">Tuesday 2 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+&quot;{\&quot;title\&quot;:\&quot;JuliaCon 2024\&quot;,\&quot;start_date\&quot;:\&quot;2024-07-22\&quot;,\&quot;end_date\&quot;:\&quot;2024-07-24\&quot;}&quot;</code></pre></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="pages/json/">JSON »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Tuesday 2 July 2024 19:39">Tuesday 2 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR55/pages/csv/index.html

@@ -9,7 +9,7 @@
 julia> parse_csv(csv)
 2-element Vector{NamedTuple{(:id, :name, :grade), Tuple{String, String, String}}}:
  (id = "1", name = "Fred", grade = "78.2")
- (id = &quot;2&quot;, name = &quot;Benny&quot;, grade = &quot;82.0&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/4c7ef21222ab458fadeb37a21fe09455d40c6a2f/src/Par/ParCsv.jl#L24-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Serde.ParCsv.CSVSyntaxError" href="#Serde.ParCsv.CSVSyntaxError"><code>Serde.ParCsv.CSVSyntaxError</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CSVSyntaxError &lt;: Exception</code></pre><p>Exception thrown when a <a href="#Serde.ParCsv.parse_csv"><code>parse_csv</code></a> fails due to incorrect CSV syntax or any underlying error that occurs during parsing.</p><p><strong>Fields</strong></p><ul><li><code>message::String</code>: The error message.</li><li><code>exception::Exception</code>: The catched exception.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/4c7ef21222ab458fadeb37a21fe09455d40c6a2f/src/Par/ParCsv.jl#L8-L16">source</a></section></article><h2 id="Deserialization"><a class="docs-heading-anchor" href="#Deserialization">Deserialization</a><a id="Deserialization-1"></a><a class="docs-heading-anchor-permalink" href="#Deserialization" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Serde.DeCsv.deser_csv" href="#Serde.DeCsv.deser_csv"><code>Serde.DeCsv.deser_csv</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">deser_csv(::Type{T}, x; kw...) -&gt; Vector{T}</code></pre><p>Creates a new object of type <code>T</code> and fill it with values from CSV formated string <code>x</code> (or vector of UInt8).</p><p>Keyword arguments <code>kw</code> is the same as in <a href="#Serde.ParCsv.parse_csv"><code>parse_csv</code></a>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; struct Data
+ (id = &quot;2&quot;, name = &quot;Benny&quot;, grade = &quot;82.0&quot;)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/f2737081d73279d58bd3a037116994b4e2ea4565/src/Par/ParCsv.jl#L24-L48">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Serde.ParCsv.CSVSyntaxError" href="#Serde.ParCsv.CSVSyntaxError"><code>Serde.ParCsv.CSVSyntaxError</code></a> — <span class="docstring-category">Type</span></header><section><div><pre><code class="language-julia hljs">CSVSyntaxError &lt;: Exception</code></pre><p>Exception thrown when a <a href="#Serde.ParCsv.parse_csv"><code>parse_csv</code></a> fails due to incorrect CSV syntax or any underlying error that occurs during parsing.</p><p><strong>Fields</strong></p><ul><li><code>message::String</code>: The error message.</li><li><code>exception::Exception</code>: The catched exception.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/f2737081d73279d58bd3a037116994b4e2ea4565/src/Par/ParCsv.jl#L8-L16">source</a></section></article><h2 id="Deserialization"><a class="docs-heading-anchor" href="#Deserialization">Deserialization</a><a id="Deserialization-1"></a><a class="docs-heading-anchor-permalink" href="#Deserialization" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Serde.DeCsv.deser_csv" href="#Serde.DeCsv.deser_csv"><code>Serde.DeCsv.deser_csv</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">deser_csv(::Type{T}, x; kw...) -&gt; Vector{T}</code></pre><p>Creates a new object of type <code>T</code> and fill it with values from CSV formated string <code>x</code> (or vector of UInt8).</p><p>Keyword arguments <code>kw</code> is the same as in <a href="#Serde.ParCsv.parse_csv"><code>parse_csv</code></a>.</p><p><strong>Examples</strong></p><pre><code class="language-julia-repl hljs">julia&gt; struct Data
            id::Int64
            name::String
            grade::Float64
@@ -24,7 +24,7 @@
 julia&gt; deser_csv(Data, csv)
 2-element Vector{Data}:
  Data(1, &quot;Fred&quot;, 78.2)
- Data(2, &quot;Benny&quot;, 82.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/4c7ef21222ab458fadeb37a21fe09455d40c6a2f/src/De/DeCsv.jl#L8-L34">source</a></section></article><h2 id="Serialization"><a class="docs-heading-anchor" href="#Serialization">Serialization</a><a id="Serialization-1"></a><a class="docs-heading-anchor-permalink" href="#Serialization" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Serde.SerCsv.to_csv" href="#Serde.SerCsv.to_csv"><code>Serde.SerCsv.to_csv</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">to_csv(data::Vector{T}; kw...) -&gt; String</code></pre><p>Uses <code>data</code> element values to make csv rows with fieldnames as columns headers. Type <code>T</code> may be a nested dictionary or a custom type. In case of nested <code>data</code>, names of resulting headers will be concatenate by &quot;_&quot; symbol using dictionary key-names or structure field names.</p><p><strong>Keyword arguments</strong></p><ul><li><code>delimiter::String = &quot;,&quot;</code>: The delimiter that will be used in the returned csv string.</li><li><code>headers::Vector{String} = String[]</code>: Specifies which column headers will be used and in what order.</li><li><code>with_names::Bool = true</code>: Determines if column headers are included in the CSV output (true to include, false to exclude).</li></ul><p><strong>Examples</strong></p><p>Converting a vector of regular dictionaries with fixed headers order.</p><pre><code class="language-julia-repl hljs">julia&gt; data = [
+ Data(2, &quot;Benny&quot;, 82.0)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/f2737081d73279d58bd3a037116994b4e2ea4565/src/De/DeCsv.jl#L8-L34">source</a></section></article><h2 id="Serialization"><a class="docs-heading-anchor" href="#Serialization">Serialization</a><a id="Serialization-1"></a><a class="docs-heading-anchor-permalink" href="#Serialization" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Serde.SerCsv.to_csv" href="#Serde.SerCsv.to_csv"><code>Serde.SerCsv.to_csv</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">to_csv(data::Vector{T}; kw...) -&gt; String</code></pre><p>Uses <code>data</code> element values to make csv rows with fieldnames as columns headers. Type <code>T</code> may be a nested dictionary or a custom type. In case of nested <code>data</code>, names of resulting headers will be concatenate by &quot;_&quot; symbol using dictionary key-names or structure field names.</p><p><strong>Keyword arguments</strong></p><ul><li><code>delimiter::String = &quot;,&quot;</code>: The delimiter that will be used in the returned csv string.</li><li><code>headers::Vector{String} = String[]</code>: Specifies which column headers will be used and in what order.</li><li><code>with_names::Bool = true</code>: Determines if column headers are included in the CSV output (true to include, false to exclude).</li></ul><p><strong>Examples</strong></p><p>Converting a vector of regular dictionaries with fixed headers order.</p><pre><code class="language-julia-repl hljs">julia&gt; data = [
            Dict(&quot;id&quot; =&gt; 1, &quot;name&quot; =&gt; &quot;Jack&quot;),
            Dict( &quot;id&quot; =&gt; 2, &quot;name&quot; =&gt; &quot;Bob&quot;),
        ];
@@ -61,4 +61,4 @@
 julia&gt; to_csv(data) |&gt; print
 str,val
 a,1
-b,2</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/4c7ef21222ab458fadeb37a21fe09455d40c6a2f/src/Ser/SerCsv.jl#L52-L118">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../toml/">« TOML</a><a class="docs-footer-nextpage" href="../query/">Query »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Tuesday 2 July 2024 19:17">Tuesday 2 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+b,2</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/bhftbootcamp/Serde.jl/blob/f2737081d73279d58bd3a037116994b4e2ea4565/src/Ser/SerCsv.jl#L52-L118">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../toml/">« TOML</a><a class="docs-footer-nextpage" href="../query/">Query »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.5.0 on <span class="colophon-date" title="Tuesday 2 July 2024 19:39">Tuesday 2 July 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>