mirror of
https://github.com/actix/actix-extras.git
synced 2025-09-02 13:06:38 +02:00
117 lines
7.6 KiB
HTML
117 lines
7.6 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `actix-session/src/storage/session_key.rs`."><title>session_key.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-9ee3a5e31a2afa3e.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="actix_session" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (e5cfc5547 2023-10-28)" data-channel="nightly" data-search-js="search-8fbf244ebcf71464.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../static.files/src-script-3280b574d94e47b4.js"></script><script defer src="../../../src-files.js"></script><script defer src="../../../static.files/main-9dd44ab47b99a0fb.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="icon" href="https://actix.rs/favicon.ico"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"></nav><main><nav class="sub"><a class="sub-logo-container" href="../../../actix_session/index.html"><img src="https://actix.rs/img/logo.png" alt="actix_session"></a><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><div data-nosnippet><pre class="src-line-numbers"><a href="#1" id="1">1</a>
|
||
<a href="#2" id="2">2</a>
|
||
<a href="#3" id="3">3</a>
|
||
<a href="#4" id="4">4</a>
|
||
<a href="#5" id="5">5</a>
|
||
<a href="#6" id="6">6</a>
|
||
<a href="#7" id="7">7</a>
|
||
<a href="#8" id="8">8</a>
|
||
<a href="#9" id="9">9</a>
|
||
<a href="#10" id="10">10</a>
|
||
<a href="#11" id="11">11</a>
|
||
<a href="#12" id="12">12</a>
|
||
<a href="#13" id="13">13</a>
|
||
<a href="#14" id="14">14</a>
|
||
<a href="#15" id="15">15</a>
|
||
<a href="#16" id="16">16</a>
|
||
<a href="#17" id="17">17</a>
|
||
<a href="#18" id="18">18</a>
|
||
<a href="#19" id="19">19</a>
|
||
<a href="#20" id="20">20</a>
|
||
<a href="#21" id="21">21</a>
|
||
<a href="#22" id="22">22</a>
|
||
<a href="#23" id="23">23</a>
|
||
<a href="#24" id="24">24</a>
|
||
<a href="#25" id="25">25</a>
|
||
<a href="#26" id="26">26</a>
|
||
<a href="#27" id="27">27</a>
|
||
<a href="#28" id="28">28</a>
|
||
<a href="#29" id="29">29</a>
|
||
<a href="#30" id="30">30</a>
|
||
<a href="#31" id="31">31</a>
|
||
<a href="#32" id="32">32</a>
|
||
<a href="#33" id="33">33</a>
|
||
<a href="#34" id="34">34</a>
|
||
<a href="#35" id="35">35</a>
|
||
<a href="#36" id="36">36</a>
|
||
<a href="#37" id="37">37</a>
|
||
<a href="#38" id="38">38</a>
|
||
<a href="#39" id="39">39</a>
|
||
<a href="#40" id="40">40</a>
|
||
<a href="#41" id="41">41</a>
|
||
<a href="#42" id="42">42</a>
|
||
<a href="#43" id="43">43</a>
|
||
<a href="#44" id="44">44</a>
|
||
<a href="#45" id="45">45</a>
|
||
<a href="#46" id="46">46</a>
|
||
<a href="#47" id="47">47</a>
|
||
<a href="#48" id="48">48</a>
|
||
<a href="#49" id="49">49</a>
|
||
<a href="#50" id="50">50</a>
|
||
<a href="#51" id="51">51</a>
|
||
<a href="#52" id="52">52</a>
|
||
<a href="#53" id="53">53</a>
|
||
<a href="#54" id="54">54</a>
|
||
<a href="#55" id="55">55</a>
|
||
<a href="#56" id="56">56</a>
|
||
<a href="#57" id="57">57</a>
|
||
<a href="#58" id="58">58</a>
|
||
</pre></div><pre class="rust"><code><span class="kw">use </span>std::convert::TryFrom;
|
||
|
||
<span class="kw">use </span>derive_more::{Display, From};
|
||
|
||
<span class="doccomment">/// A session key, the string stored in a client-side cookie to associate a user with its session
|
||
/// state on the backend.
|
||
///
|
||
/// # Validation
|
||
/// Session keys are stored as cookies, therefore they cannot be arbitrary long. Session keys are
|
||
/// required to be smaller than 4064 bytes.
|
||
///
|
||
/// ```rust
|
||
/// # use std::convert::TryInto;
|
||
/// use actix_session::storage::SessionKey;
|
||
///
|
||
/// let key: String = std::iter::repeat('a').take(4065).collect();
|
||
/// let session_key: Result<SessionKey, _> = key.try_into();
|
||
/// assert!(session_key.is_err());
|
||
/// ```
|
||
</span><span class="attr">#[derive(Debug, PartialEq, Eq)]
|
||
</span><span class="kw">pub struct </span>SessionKey(String);
|
||
|
||
<span class="kw">impl </span>TryFrom<String> <span class="kw">for </span>SessionKey {
|
||
<span class="kw">type </span>Error = InvalidSessionKeyError;
|
||
|
||
<span class="kw">fn </span>try_from(val: String) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, <span class="self">Self</span>::Error> {
|
||
<span class="kw">if </span>val.len() > <span class="number">4064 </span>{
|
||
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">anyhow::anyhow!</span>(
|
||
<span class="string">"The session key is bigger than 4064 bytes, the upper limit on cookie content."
|
||
</span>)
|
||
.into());
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(SessionKey(val))
|
||
}
|
||
}
|
||
|
||
<span class="kw">impl </span>AsRef<str> <span class="kw">for </span>SessionKey {
|
||
<span class="kw">fn </span>as_ref(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str {
|
||
<span class="kw-2">&</span><span class="self">self</span>.<span class="number">0
|
||
</span>}
|
||
}
|
||
|
||
<span class="kw">impl </span>From<SessionKey> <span class="kw">for </span>String {
|
||
<span class="kw">fn </span>from(key: SessionKey) -> <span class="self">Self </span>{
|
||
key.<span class="number">0
|
||
</span>}
|
||
}
|
||
|
||
<span class="attr">#[derive(Debug, Display, From)]
|
||
#[display(fmt = <span class="string">"The provided string is not a valid session key"</span>)]
|
||
</span><span class="kw">pub struct </span>InvalidSessionKeyError(anyhow::Error);
|
||
|
||
<span class="kw">impl </span>std::error::Error <span class="kw">for </span>InvalidSessionKeyError {
|
||
<span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>std::error::Error + <span class="lifetime">'static</span>)> {
|
||
<span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="number">0</span>.as_ref())
|
||
}
|
||
}
|
||
</code></pre></div></section></main></body></html> |