mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-25 12:44:07 +01:00
31 lines
12 KiB
HTML
31 lines
12 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="A trait for the ability to store server session data."><title>StoresServerSessions in rustls::server - Rust</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/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rustls" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../rustls/index.html">rustls</a><span class="version">0.21.7</span></h2></div><h2 class="location"><a href="#">StoresServerSessions</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.can_cache">can_cache</a></li><li><a href="#tymethod.get">get</a></li><li><a href="#tymethod.put">put</a></li><li><a href="#tymethod.take">take</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rustls::server</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../rustls/all.html" title="show sidebar"></a></div><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" tabindex="-1"><a href="../../help.html" title="help">?</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="main-heading"><h1>Trait <a href="../index.html">rustls</a>::<wbr><a href="index.html">server</a>::<wbr><a class="trait" href="#">StoresServerSessions</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/rustls/server/server_conn.rs.html#46-64">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait StoresServerSessions: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.put" class="fn">put</a>(&self, key: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>, value: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.get" class="fn">get</a>(&self, key: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.take" class="fn">take</a>(&self, key: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.can_cache" class="fn">can_cache</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for the ability to store server session data.</p>
|
||
<p>The keys and values are opaque.</p>
|
||
<p>Both the keys and values should be treated as
|
||
<strong>highly sensitive data</strong>, containing enough key material
|
||
to break all security of the corresponding sessions.</p>
|
||
<p>Implementations can be lossy (in other words, forgetting
|
||
key/value pairs) without any negative security consequences.</p>
|
||
<p>However, note that <code>take</code> <strong>must</strong> reliably delete a returned
|
||
value. If it does not, there may be security consequences.</p>
|
||
<p><code>put</code> and <code>take</code> are mutating operations; this isn’t expressed
|
||
in the type system to allow implementations freedom in
|
||
how to achieve interior mutability. <code>Mutex</code> is a common
|
||
choice.</p>
|
||
</div></details><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.put" class="method"><a class="src rightside" href="../../src/rustls/server/server_conn.rs.html#50">source</a><h4 class="code-header">fn <a href="#tymethod.put" class="fn">put</a>(&self, key: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>, value: <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Store session secrets encoded in <code>value</code> against <code>key</code>,
|
||
overwrites any existing value against <code>key</code>. Returns <code>true</code>
|
||
if the value was stored.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.get" class="method"><a class="src rightside" href="../../src/rustls/server/server_conn.rs.html#54">source</a><h4 class="code-header">fn <a href="#tymethod.get" class="fn">get</a>(&self, key: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>></h4></section></summary><div class="docblock"><p>Find a value with the given <code>key</code>. Return it, or None
|
||
if it doesn’t exist.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.take" class="method"><a class="src rightside" href="../../src/rustls/server/server_conn.rs.html#58">source</a><h4 class="code-header">fn <a href="#tymethod.take" class="fn">take</a>(&self, key: &[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>>></h4></section></summary><div class="docblock"><p>Find a value with the given <code>key</code>. Return it and delete it;
|
||
or None if it doesn’t exist.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.can_cache" class="method"><a class="src rightside" href="../../src/rustls/server/server_conn.rs.html#63">source</a><h4 class="code-header">fn <a href="#tymethod.can_cache" class="fn">can_cache</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Whether the store can cache another session. This is used to indicate to clients
|
||
whether their session can be resumed; the implementation is not required to remember
|
||
a session even if it returns <code>true</code> here.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-StoresServerSessions-for-NoServerSessionStorage" class="impl"><a class="src rightside" href="../../src/rustls/server/handy.rs.html#15-28">source</a><a href="#impl-StoresServerSessions-for-NoServerSessionStorage" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StoresServerSessions.html" title="trait rustls::server::StoresServerSessions">StoresServerSessions</a> for <a class="struct" href="struct.NoServerSessionStorage.html" title="struct rustls::server::NoServerSessionStorage">NoServerSessionStorage</a></h3></section><section id="impl-StoresServerSessions-for-ServerSessionMemoryCache" class="impl"><a class="src rightside" href="../../src/rustls/server/handy.rs.html#48-72">source</a><a href="#impl-StoresServerSessions-for-ServerSessionMemoryCache" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.StoresServerSessions.html" title="trait rustls::server::StoresServerSessions">StoresServerSessions</a> for <a class="struct" href="struct.ServerSessionMemoryCache.html" title="struct rustls::server::ServerSessionMemoryCache">ServerSessionMemoryCache</a></h3></section></div><script src="../../trait.impl/rustls/server/server_conn/trait.StoresServerSessions.js" async></script></section></div></main></body></html> |