mirror of
https://github.com/actix/actix-extras.git
synced 2024-11-28 09:42:40 +01:00
21 lines
13 KiB
HTML
21 lines
13 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="Identity policy."><meta name="keywords" content="rust, rustlang, rust-lang, IdentityPolicy"><title>IdentityPolicy in actix_identity - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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><a class="sidebar-logo" href="../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"></h2>
|
||
</nav>
|
||
<nav class="sidebar"><a class="sidebar-logo" href="../actix_identity/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"><a href="#">IdentityPolicy</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-associated-types">Required Associated Types</a></h3><ul><li><a href="#associatedtype.Future">Future</a></li><li><a href="#associatedtype.ResponseFuture">ResponseFuture</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.from_request">from_request</a></li><li><a href="#tymethod.to_response">to_response</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In actix_identity</a></h2><div id="sidebar-vars" data-name="IdentityPolicy" data-ty="trait" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../actix_identity/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><button type="button" id="help-button" title="help">?</button><div id="settings-menu" tabindex="-1">
|
||
<a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
|
||
</div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
|
||
<h1 class="fqn"><span class="in-band">Trait <a href="index.html">actix_identity</a>::<wbr><a class="trait" href="#">IdentityPolicy</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/actix_identity/lib.rs.html#71-89">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait IdentityPolicy: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> + 'static {
|
||
type <a href="#associatedtype.Future" class="associatedtype">Future</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>>;
|
||
type <a href="#associatedtype.ResponseFuture" class="associatedtype">ResponseFuture</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>>;
|
||
|
||
fn <a href="#tymethod.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="associatedtype" href="trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.to_response" class="fnname">to_response</a><B>(<br> &self, <br> identity: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> response: &mut ServiceResponse<B><br> ) -> Self::<a class="associatedtype" href="trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a>;
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Identity policy.</p>
|
||
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="associatedtype.Future" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/actix_identity/lib.rs.html#73">source</a></div><h4 class="code-header">type <a href="#associatedtype.Future" class="associatedtype">Future</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></h4></div></summary><div class="docblock"><p>The return type of the middleware</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="associatedtype.ResponseFuture" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/actix_identity/lib.rs.html#76">source</a></div><h4 class="code-header">type <a href="#associatedtype.ResponseFuture" class="associatedtype">ResponseFuture</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = Result<<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>></h4></div></summary><div class="docblock"><p>The return type of the middleware</p>
|
||
</div></details></div><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.from_request" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/actix_identity/lib.rs.html#80">source</a></div><h4 class="code-header">fn <a href="#tymethod.from_request" class="fnname">from_request</a>(&self, req: &mut ServiceRequest) -> Self::<a class="associatedtype" href="trait.IdentityPolicy.html#associatedtype.Future" title="type actix_identity::IdentityPolicy::Future">Future</a></h4></div></summary><div class="docblock"><p>Parse the session from request and load data from a service identity.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="tymethod.to_response" class="method has-srclink"><div class="rightside"><a class="srclink" href="../src/actix_identity/lib.rs.html#83-88">source</a></div><h4 class="code-header">fn <a href="#tymethod.to_response" class="fnname">to_response</a><B>(<br> &self, <br> identity: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, <br> changed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, <br> response: &mut ServiceResponse<B><br>) -> Self::<a class="associatedtype" href="trait.IdentityPolicy.html#associatedtype.ResponseFuture" title="type actix_identity::IdentityPolicy::ResponseFuture">ResponseFuture</a></h4></div></summary><div class="docblock"><p>Write changes to response</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IdentityPolicy" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_identity/cookie.rs.html#302-366">source</a></span><a href="#impl-IdentityPolicy" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.IdentityPolicy.html" title="trait actix_identity::IdentityPolicy">IdentityPolicy</a> for <a class="struct" href="struct.CookieIdentityPolicy.html" title="struct actix_identity::CookieIdentityPolicy">CookieIdentityPolicy</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Future-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Future-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.Future" class="associatedtype">Future</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>>, Error>></h4></section><section id="associatedtype.ResponseFuture-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.ResponseFuture-1" class="anchor"></a><h4 class="code-header">type <a href="#associatedtype.ResponseFuture" class="associatedtype">ResponseFuture</a> = Ready<<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, Error>></h4></section></div></details></div><script type="text/javascript" src="../implementors/actix_identity/trait.IdentityPolicy.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="actix_identity" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.63.0-nightly (b31f9cc22 2022-06-15)" ></div>
|
||
</body></html> |