mirror of
https://github.com/actix/actix-website
synced 2024-12-18 18:03:12 +01:00
20 lines
8.0 KiB
HTML
20 lines
8.0 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="API documentation for the Rust `Identity` trait in crate `actix_web`."><meta name="keywords" content="rust, rustlang, rust-lang, Identity"><title>actix_web::middleware::identity::Identity - Rust</title><link rel="stylesheet" type="text/css" href="../../../normalize.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark.css"><link rel="stylesheet" type="text/css" href="../../../light.css" id="themeStyle"><script src="../../../storage.js"></script></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Trait Identity</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.identity">identity</a><a href="#tymethod.remember">remember</a><a href="#tymethod.forget">forget</a><a href="#tymethod.write">write</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>middleware</a>::<wbr><a href='index.html'>identity</a></p><script>window.sidebarCurrent = {name: 'Identity', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../../src/actix_web/middleware/identity.rs.html#123-137' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>actix_web</a>::<wbr><a href='../index.html'>middleware</a>::<wbr><a href='index.html'>identity</a>::<wbr><a class="trait" href=''>Identity</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Identity: 'static {
|
||
fn <a href='#tymethod.identity' class='fnname'>identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>>;
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.remember' class='fnname'>remember</a>(&mut self, key: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.forget' class='fnname'>forget</a>(&mut self);
|
||
<div class='item-spacer'></div> fn <a href='#tymethod.write' class='fnname'>write</a>(&mut self, resp: <a class="struct" href="../../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a>) -> <a class="type" href="../../../actix_web/error/type.Result.html" title="type actix_web::error::Result">Result</a><<a class="enum" href="../../../actix_web/middleware/enum.Response.html" title="enum actix_web::middleware::Response">Response</a>>;
|
||
}</pre></div><div class='docblock'><p>An identity</p>
|
||
</div>
|
||
<h2 id='required-methods' class='small-section-header'>
|
||
Required Methods<a href='#required-methods' class='anchor'></a>
|
||
</h2>
|
||
<div class='methods'>
|
||
<h3 id='tymethod.identity' class='method'><span id='identity.v' class='invisible'><code>fn <a href='#tymethod.identity' class='fnname'>identity</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>></code></span></h3><div class='docblock'><p>Return the claimed identity of the user associated request or
|
||
<code>None</code> if no identity can be found associated with the request.</p>
|
||
</div><h3 id='tymethod.remember' class='method'><span id='remember.v' class='invisible'><code>fn <a href='#tymethod.remember' class='fnname'>remember</a>(&mut self, key: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>)</code></span></h3><div class='docblock'><p>Remember identity.</p>
|
||
</div><h3 id='tymethod.forget' class='method'><span id='forget.v' class='invisible'><code>fn <a href='#tymethod.forget' class='fnname'>forget</a>(&mut self)</code></span></h3><div class='docblock'><p>This method is used to 'forget' the current identity on subsequent
|
||
requests.</p>
|
||
</div><h3 id='tymethod.write' class='method'><span id='write.v' class='invisible'><code>fn <a href='#tymethod.write' class='fnname'>write</a>(&mut self, resp: <a class="struct" href="../../../actix_web/struct.HttpResponse.html" title="struct actix_web::HttpResponse">HttpResponse</a>) -> <a class="type" href="../../../actix_web/error/type.Result.html" title="type actix_web::error::Result">Result</a><<a class="enum" href="../../../actix_web/middleware/enum.Response.html" title="enum actix_web::middleware::Response">Response</a>></code></span></h3><div class='docblock'><p>Write session to storage backend.</p>
|
||
</div></div><h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'></div><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
||
src="../../../implementors/actix_web/middleware/identity/trait.Identity.js">
|
||
</script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "actix_web";</script><script src="../../../aliases.js"></script><script src="../../../main.js"></script><script defer src="../../../search-index.js"></script></body></html> |