build based on 1f1da6d

dev/API/cookies.html

@@ -5,4 +5,4 @@
   &quot;A&quot; =&gt; 1</code></pre><p>Alternatively, a sequence of pair arguments may be passed.</p><pre><code class="language-julia-repl hljs">julia&gt; Dict(&quot;A&quot;=&gt;1, &quot;B&quot;=&gt;2)
 Dict{String, Int64} with 2 entries:
   &quot;B&quot; =&gt; 2
-  &quot;A&quot; =&gt; 1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/bd47eca2c8aacd145b6c5c02e47e2b9ec27ab456/base/dict.jl#L31-L56">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.get" href="#Genie.Cookies.get"><code>Genie.Cookies.get</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get(payload::Union{HTTP.Response,HTTP.Request}, key::Union{String,Symbol}, default::T; encrypted::Bool = true)::T where T</code></pre><p>Attempts to get the Cookie value stored at <code>key</code> within <code>payload</code>. If the <code>key</code> is not set, the <code>default</code> value is returned.</p><p><strong>Arguments</strong></p><ul><li><code>payload::Union{HTTP.Response,HTTP.Request}</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>default::T</code>: default value to be returned if no cookie value is set at <code>key</code></li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/8db5118c6475504ab5ef413a703ccfec76e5d3e9/src/Cookies.jl#L10-L21">source</a></section><section><div><pre><code class="nohighlight hljs">get(res::HTTP.Response, key::Union{String,Symbol}) :: Union{Nothing,String}</code></pre><p>Retrieves a value stored on the cookie as <code>key</code> from the <code>Respose</code> object.</p><p><strong>Arguments</strong></p><ul><li><code>payload::Union{HTTP.Response,HTTP.Request}</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/8db5118c6475504ab5ef413a703ccfec76e5d3e9/src/Cookies.jl#L28-L37">source</a></section><section><div><pre><code class="nohighlight hljs">get(req::Request, key::Union{String,Symbol}) :: Union{Nothing,String}</code></pre><p>Retrieves a value stored on the cookie as <code>key</code> from the <code>Request</code> object.</p><p><strong>Arguments</strong></p><ul><li><code>req::HTTP.Request</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/8db5118c6475504ab5ef413a703ccfec76e5d3e9/src/Cookies.jl#L45-L54">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.getcookies" href="#Genie.Cookies.getcookies"><code>Genie.Cookies.getcookies</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">getcookies(req::HTTP.Request) :: Vector{HTTP.Cookies.Cookie}</code></pre><p>Extracts cookies from within <code>req</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/8db5118c6475504ab5ef413a703ccfec76e5d3e9/src/Cookies.jl#L160-L164">source</a></section><section><div><pre><code class="nohighlight hljs">getcookies(req::HTTP.Request) :: Vector{HTTP.Cookies.Cookie}</code></pre><p>Extracts cookies from within <code>req</code>, filtering them by <code>matching</code> name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/8db5118c6475504ab5ef413a703ccfec76e5d3e9/src/Cookies.jl#L170-L174">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.set!" href="#Genie.Cookies.set!"><code>Genie.Cookies.set!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set!(res::HTTP.Response, key::Union{String,Symbol}, value::Any, attributes::Dict; encrypted::Bool = true) :: HTTP.Response</code></pre><p>Sets <code>value</code> under the <code>key</code> label on the <code>Cookie</code>.</p><p><strong>Arguments</strong></p><ul><li><code>res::HTTP.Response</code>: the HTTP.Response object</li><li><code>key::Union{String,Symbol}</code>: the key for storing the cookie value</li><li><code>value::Any</code>: the cookie value</li><li><code>attributes::Dict</code>: additional cookie attributes, such as <code>path</code>, <code>httponly</code>, <code>maxage</code></li><li><code>encrypted::Bool</code>: if <code>true</code> the value is stored encoded</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/8db5118c6475504ab5ef413a703ccfec76e5d3e9/src/Cookies.jl#L62-L73">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.nullablevalue" href="#Genie.Cookies.nullablevalue"><code>Genie.Cookies.nullablevalue</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">nullablevalue(payload::Union{HTTP.Response,HTTP.Request}, key::Union{String,Symbol}; encrypted::Bool = true)</code></pre><p>Attempts to retrieve a cookie value stored at <code>key</code> in the <code>payload object</code> and returns a <code>Union{Nothing,String}</code></p><p><strong>Arguments</strong></p><ul><li><code>payload::Union{HTTP.Response,HTTP.Request}</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/8db5118c6475504ab5ef413a703ccfec76e5d3e9/src/Cookies.jl#L135-L144">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="configuration.html">« Configuration</a><a class="docs-footer-nextpage" href="encryption.html">Encryption »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 26 March 2024 13:00">Tuesday 26 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+  &quot;A&quot; =&gt; 1</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/bd47eca2c8aacd145b6c5c02e47e2b9ec27ab456/base/dict.jl#L31-L56">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.get" href="#Genie.Cookies.get"><code>Genie.Cookies.get</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">get(payload::Union{HTTP.Response,HTTP.Request}, key::Union{String,Symbol}, default::T; encrypted::Bool = true)::T where T</code></pre><p>Attempts to get the Cookie value stored at <code>key</code> within <code>payload</code>. If the <code>key</code> is not set, the <code>default</code> value is returned.</p><p><strong>Arguments</strong></p><ul><li><code>payload::Union{HTTP.Response,HTTP.Request}</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>default::T</code>: default value to be returned if no cookie value is set at <code>key</code></li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/1f1da6d3c6f6dff7f2b8a500c89e59f5b2d4f754/src/Cookies.jl#L10-L21">source</a></section><section><div><pre><code class="nohighlight hljs">get(res::HTTP.Response, key::Union{String,Symbol}) :: Union{Nothing,String}</code></pre><p>Retrieves a value stored on the cookie as <code>key</code> from the <code>Respose</code> object.</p><p><strong>Arguments</strong></p><ul><li><code>payload::Union{HTTP.Response,HTTP.Request}</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/1f1da6d3c6f6dff7f2b8a500c89e59f5b2d4f754/src/Cookies.jl#L28-L37">source</a></section><section><div><pre><code class="nohighlight hljs">get(req::Request, key::Union{String,Symbol}) :: Union{Nothing,String}</code></pre><p>Retrieves a value stored on the cookie as <code>key</code> from the <code>Request</code> object.</p><p><strong>Arguments</strong></p><ul><li><code>req::HTTP.Request</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/1f1da6d3c6f6dff7f2b8a500c89e59f5b2d4f754/src/Cookies.jl#L45-L54">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.getcookies" href="#Genie.Cookies.getcookies"><code>Genie.Cookies.getcookies</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">getcookies(req::HTTP.Request) :: Vector{HTTP.Cookies.Cookie}</code></pre><p>Extracts cookies from within <code>req</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/1f1da6d3c6f6dff7f2b8a500c89e59f5b2d4f754/src/Cookies.jl#L160-L164">source</a></section><section><div><pre><code class="nohighlight hljs">getcookies(req::HTTP.Request) :: Vector{HTTP.Cookies.Cookie}</code></pre><p>Extracts cookies from within <code>req</code>, filtering them by <code>matching</code> name.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/1f1da6d3c6f6dff7f2b8a500c89e59f5b2d4f754/src/Cookies.jl#L170-L174">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.set!" href="#Genie.Cookies.set!"><code>Genie.Cookies.set!</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">set!(res::HTTP.Response, key::Union{String,Symbol}, value::Any, attributes::Dict; encrypted::Bool = true) :: HTTP.Response</code></pre><p>Sets <code>value</code> under the <code>key</code> label on the <code>Cookie</code>.</p><p><strong>Arguments</strong></p><ul><li><code>res::HTTP.Response</code>: the HTTP.Response object</li><li><code>key::Union{String,Symbol}</code>: the key for storing the cookie value</li><li><code>value::Any</code>: the cookie value</li><li><code>attributes::Dict</code>: additional cookie attributes, such as <code>path</code>, <code>httponly</code>, <code>maxage</code></li><li><code>encrypted::Bool</code>: if <code>true</code> the value is stored encoded</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/1f1da6d3c6f6dff7f2b8a500c89e59f5b2d4f754/src/Cookies.jl#L62-L73">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Genie.Cookies.nullablevalue" href="#Genie.Cookies.nullablevalue"><code>Genie.Cookies.nullablevalue</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">nullablevalue(payload::Union{HTTP.Response,HTTP.Request}, key::Union{String,Symbol}; encrypted::Bool = true)</code></pre><p>Attempts to retrieve a cookie value stored at <code>key</code> in the <code>payload object</code> and returns a <code>Union{Nothing,String}</code></p><p><strong>Arguments</strong></p><ul><li><code>payload::Union{HTTP.Response,HTTP.Request}</code>: the request or response object containing the Cookie headers</li><li><code>key::Union{String,Symbol}</code>: the name of the cookie value</li><li><code>encrypted::Bool</code>: if <code>true</code> the value stored on the cookie is automatically decrypted</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/GenieFramework/Genie.jl/blob/1f1da6d3c6f6dff7f2b8a500c89e59f5b2d4f754/src/Cookies.jl#L135-L144">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="configuration.html">« Configuration</a><a class="docs-footer-nextpage" href="encryption.html">Encryption »</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="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Friday 12 April 2024 13:58">Friday 12 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>