mirror of
https://github.com/actix/actix-extras.git
synced 2025-08-30 19:10:20 +02:00
Deploying to gh-pages from @ 7c3c9357e0 🚀
This commit is contained in:
robjtede
@@ -49,7 +49,7 @@ control of the error path.</p>
|
||||
.<span class="ident">finish</span>()
|
||||
}
|
||||
}</code></pre></div>
|
||||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Identity" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_identity/identity.rs.html#112-232">source</a></span><a href="#impl-Identity" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.id" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_identity/identity.rs.html#129-133">source</a></span><h4 class="code-header">pub fn <a href="#method.id" class="fnname">id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.58/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></section></summary><div class="docblock"><p>Return the user id associated to the current session.</p>
|
||||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Identity" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_identity/identity.rs.html#112-232">source</a></span><a href="#impl-Identity" class="anchor"></a><h3 class="code-header in-band">impl <a class="struct" href="struct.Identity.html" title="struct actix_identity::Identity">Identity</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.id" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_identity/identity.rs.html#129-133">source</a></span><h4 class="code-header">pub fn <a href="#method.id" class="fnname">id</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="struct" href="https://docs.rs/anyhow/1.0.60/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></section></summary><div class="docblock"><p>Return the user id associated to the current session.</p>
|
||||
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
|
||||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">actix_web</span>::{<span class="ident">get</span>, <span class="ident">Responder</span>};
|
||||
<span class="kw">use</span> <span class="ident">actix_identity::Identity</span>;
|
||||
@@ -62,7 +62,7 @@ control of the error path.</p>
|
||||
<span class="string">"Welcome Anonymous!"</span>.<span class="ident">to_owned</span>()
|
||||
}
|
||||
}</code></pre></div>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.login" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_identity/identity.rs.html#152-164">source</a></span><h4 class="code-header">pub fn <a href="#method.login" class="fnname">login</a>(ext: &Extensions, id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://docs.rs/anyhow/1.0.58/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></section></summary><div class="docblock"><p>Attach a valid user identity to the current session.</p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.login" class="method has-srclink"><span class="rightside"><a class="srclink" href="../src/actix_identity/identity.rs.html#152-164">source</a></span><h4 class="code-header">pub fn <a href="#method.login" class="fnname">login</a>(ext: &Extensions, id: <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, <a class="struct" href="https://docs.rs/anyhow/1.0.60/anyhow/struct.Error.html" title="struct anyhow::Error">Error</a>></h4></section></summary><div class="docblock"><p>Attach a valid user identity to the current session.</p>
|
||||
<p>This method should be called after you have successfully authenticated the user. After
|
||||
<code>login</code> has been called, the user will be able to access all routes that require a valid
|
||||
<a href="struct.Identity.html" title="Identity"><code>Identity</code></a>.</p>
|
||||
@@ -125,4 +125,4 @@ require a valid <a href="struct.Identity.html" title="Identity"><code>Identity</
|
||||
<a href="https://docs.rs/tracing/0.1.36/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.36/tracing/instrument/trait.WithSubscriber.html#method.with_subscriber">Read more</a></p>
|
||||
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_current_subscriber" class="method trait-impl has-srclink"><span class="rightside"><a class="srclink" href="https://docs.rs/tracing/0.1.36/src/tracing/instrument.rs.html#221">source</a></span><a href="#method.with_current_subscriber" class="anchor"></a><h4 class="code-header">fn <a href="https://docs.rs/tracing/0.1.36/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber" class="fnname">with_current_subscriber</a>(self) -> <a class="struct" href="https://docs.rs/tracing/0.1.36/tracing/instrument/struct.WithDispatch.html" title="struct tracing::instrument::WithDispatch">WithDispatch</a><Self></h4></section></summary><div class='docblock'><p>Attaches the current <a href="https://docs.rs/tracing/0.1.36/tracing/dispatcher/index.html#setting-the-default-subscriber">default</a> <a href="https://docs.rs/tracing-core/0.1.22/tracing_core/subscriber/trait.Subscriber.html"><code>Subscriber</code></a> to this type, returning a
|
||||
<a href="https://docs.rs/tracing/0.1.36/tracing/instrument/struct.WithDispatch.html" title="WithDispatch"><code>WithDispatch</code></a> wrapper. <a href="https://docs.rs/tracing/0.1.36/tracing/instrument/trait.WithSubscriber.html#method.with_current_subscriber">Read more</a></p>
|
||||
</div></details></div></details></div></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.64.0-nightly (0f4bcadb4 2022-07-30)" ></div></body></html>
|
||||
</div></details></div></details></div></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.65.0-nightly (2befdefdd 2022-08-06)" ></div></body></html>
|
||||
Reference in New Issue
Block a user