actix/actix-extras
1
0
Fork 0
mirror of https://github.com/actix/actix-extras.git synced 2025-08-31 03:20:20 +02:00
Code Issues Releases Wiki Activity

Deploying to gh-pages from @ actix/actix-extras@3fad53211a 🚀

Browse Source
This commit is contained in:
robjtede
2023-09-16 02:30:40 +00:00
parent f1a8df9a39
commit 823870921b
14 changed files with 17 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
actix_identity/error/enum.GetIdentityError.html
View File

File diff suppressed because one or more lines are too long

2
actix_identity/error/struct.LoginError.html
View File

File diff suppressed because one or more lines are too long

2
actix_identity/error/struct.MissingIdentityError.html
View File

File diff suppressed because one or more lines are too long

2
actix_identity/error/struct.SessionExpiryError.html
View File

File diff suppressed because one or more lines are too long

2
actix_identity/index.html
View File

@@ -1,4 +1,4 @@
<!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 management for Actix Web."><title>actix_identity - 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/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-ae1b282cda4c21ec.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_identity" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0-nightly (20999de3a 2023-09-15)" data-channel="nightly" data-search-js="search-5d3eaacf19ebf04f.js" data-settings-js="settings-74424d7eec62a23e.js" data-theme-light-css="light-f194925aa375ae96.css" data-theme-dark-css="dark-1dd4d1ce031e15de.css" data-theme-ayu-css="ayu-49e58d069f567085.css" ><script src="../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-cabe4b1bd7b9da95.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../static.files/light-f194925aa375ae96.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../static.files/dark-1dd4d1ce031e15de.css"><link rel="stylesheet" href="../static.files/noscript-cffde32267a19fd6.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 mod crate"><!--[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">&#9776;</button><a class="logo-container" href="../actix_identity/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../actix_identity/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate actix_identity</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.5.2</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1>Crate <a class="mod" href="#">actix_identity</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/actix_identity/lib.rs.html#1-99">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Identity management for Actix Web.</p>
<!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 management for Actix Web."><title>actix_identity - 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/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-ae1b282cda4c21ec.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="actix_identity" data-themes="" data-resource-suffix="" data-rustdoc-version="1.74.0-nightly (20999de3a 2023-09-15)" data-channel="nightly" data-search-js="search-5d3eaacf19ebf04f.js" data-settings-js="settings-74424d7eec62a23e.js" data-theme-light-css="light-f194925aa375ae96.css" data-theme-dark-css="dark-1dd4d1ce031e15de.css" data-theme-ayu-css="ayu-49e58d069f567085.css" ><script src="../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-cabe4b1bd7b9da95.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../static.files/light-f194925aa375ae96.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../static.files/dark-1dd4d1ce031e15de.css"><link rel="stylesheet" href="../static.files/noscript-cffde32267a19fd6.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 mod crate"><!--[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">&#9776;</button><a class="logo-container" href="../actix_identity/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../actix_identity/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate actix_identity</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.6.0</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1>Crate <a class="mod" href="#">actix_identity</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/actix_identity/lib.rs.html#1-99">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Identity management for Actix Web.</p>
<p><code>actix-identity</code> can be used to track identity of a user across multiple requests. It is built
on top of HTTP sessions, via <a href="https://docs.rs/actix-session"><code>actix-session</code></a>.</p>
<h2 id="getting-started"><a href="#getting-started">Getting started</a></h2>

2
actix_identity/trait.IdentityExt.html
View File

@@ -3,4 +3,4 @@
fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helper trait to retrieve an <a href="struct.Identity.html" title="struct actix_identity::Identity"><code>Identity</code></a> instance from various <code>actix-web</code>’s types.</p>
</div></details><h2 id="required-methods" class="small-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.get_identity" class="method"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#8">source</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></summary><div class="docblock"><p>Retrieve the identity attached to the current session, if available.</p>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-GuardContext%3C'a%3E" class="impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#23-27">source</a><a href="#impl-IdentityExt-for-GuardContext%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for GuardContext&lt;'a&gt;</h3></section></summary><div class="impl-items"><section id="method.get_identity" class="method trait-impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#24-26">source</a><a href="#method.get_identity" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-HttpRequest" class="impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#11-15">source</a><a href="#impl-IdentityExt-for-HttpRequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for HttpRequest</h3></section></summary><div class="impl-items"><section id="method.get_identity-1" class="method trait-impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#12-14">source</a><a href="#method.get_identity-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-ServiceRequest" class="impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#17-21">source</a><a href="#impl-IdentityExt-for-ServiceRequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for ServiceRequest</h3></section></summary><div class="impl-items"><section id="method.get_identity-2" class="method trait-impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#18-20">source</a><a href="#method.get_identity-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../implementors/actix_identity/identity_ext/trait.IdentityExt.js" data-ignore-extern-crates="actix_web" async></script></section></div></main></body></html>
</div></details></div><h2 id="foreign-impls" class="small-section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-HttpRequest" class="impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#11-15">source</a><a href="#impl-IdentityExt-for-HttpRequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for HttpRequest</h3></section></summary><div class="impl-items"><section id="method.get_identity" class="method trait-impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#12-14">source</a><a href="#method.get_identity" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-ServiceRequest" class="impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#17-21">source</a><a href="#impl-IdentityExt-for-ServiceRequest" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for ServiceRequest</h3></section></summary><div class="impl-items"><section id="method.get_identity-1" class="method trait-impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#18-20">source</a><a href="#method.get_identity-1" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-IdentityExt-for-GuardContext%3C'a%3E" class="impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#23-27">source</a><a href="#impl-IdentityExt-for-GuardContext%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.IdentityExt.html" title="trait actix_identity::IdentityExt">IdentityExt</a> for GuardContext&lt;'a&gt;</h3></section></summary><div class="impl-items"><section id="method.get_identity-2" class="method trait-impl"><a class="src rightside" href="../src/actix_identity/identity_ext.rs.html#24-26">source</a><a href="#method.get_identity-2" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.get_identity" class="fn">get_identity</a>(&amp;self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a>, <a class="enum" href="error/enum.GetIdentityError.html" title="enum actix_identity::error::GetIdentityError">GetIdentityError</a>&gt;</h4></section></div></details><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../implementors/actix_identity/identity_ext/trait.IdentityExt.js" data-ignore-extern-crates="actix_web" async></script></section></div></main></body></html>