mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-06 13:22:57 +00:00
77 lines
16 KiB
HTML
77 lines
16 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 `UserProvider` trait in crate `auth`."><title>UserProvider in auth - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="auth" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0-nightly (fa3155a64 2025-09-30)" data-channel="nightly" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-828709d0.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-ce535bd0.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">UserProvider</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../auth/index.html">auth</a><span class="version">1.0.0-beta.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">User<wbr>Provider</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.authenticate" title="authenticate">authenticate</a></li><li><a href="#tymethod.authorize" title="authorize">authorize</a></li><li><a href="#tymethod.name" title="name">name</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.auth" title="auth">auth</a></li><li><a href="#method.external" title="external">external</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate auth</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">auth</a></div><h1>Trait <span class="trait">User<wbr>Provider</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/auth/user_provider.rs.html#36-65">Source</a> </span></div><pre class="rust item-decl"><code>pub trait UserProvider: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.name" class="fn">name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.authenticate" class="fn">authenticate</a><'life0, 'life1, 'life2, 'async_trait>(
|
||
&'life0 self,
|
||
id: <a class="enum" href="enum.Identity.html" title="enum auth::Identity">Identity</a><'life1>,
|
||
password: <a class="enum" href="enum.Password.html" title="enum auth::Password">Password</a><'life2>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="type" href="error/type.Result.html" title="type auth::error::Result">Result</a><<a class="type" href="type.UserInfoRef.html" title="type auth::UserInfoRef">UserInfoRef</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait,
|
||
'life1: 'async_trait,
|
||
'life2: 'async_trait</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.authorize" class="fn">authorize</a><'life0, 'life1, 'life2, 'life3, 'async_trait>(
|
||
&'life0 self,
|
||
catalog: &'life1 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
schema: &'life2 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
user_info: &'life3 <a class="type" href="type.UserInfoRef.html" title="type auth::UserInfoRef">UserInfoRef</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="type" href="error/type.Result.html" title="type auth::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait,
|
||
'life1: 'async_trait,
|
||
'life2: 'async_trait,
|
||
'life3: 'async_trait</span>;
|
||
|
||
// Provided methods
|
||
fn <a href="#method.auth" class="fn">auth</a><'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
|
||
&'life0 self,
|
||
id: <a class="enum" href="enum.Identity.html" title="enum auth::Identity">Identity</a><'life1>,
|
||
password: <a class="enum" href="enum.Password.html" title="enum auth::Password">Password</a><'life2>,
|
||
catalog: &'life3 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
schema: &'life4 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="type" href="error/type.Result.html" title="type auth::error::Result">Result</a><<a class="type" href="type.UserInfoRef.html" title="type auth::UserInfoRef">UserInfoRef</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>>
|
||
<span class="where">where Self: 'async_trait,
|
||
'life0: 'async_trait,
|
||
'life1: 'async_trait,
|
||
'life2: 'async_trait,
|
||
'life3: 'async_trait,
|
||
'life4: 'async_trait</span> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.external" class="fn">external</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> { ... }
|
||
}</code></pre><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.name" class="method"><a class="src rightside" href="../src/auth/user_provider.rs.html#37">Source</a><h4 class="code-header">fn <a href="#tymethod.name" class="fn">name</a>(&self) -> &<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a></h4></section><details class="toggle method-toggle" open><summary><section id="tymethod.authenticate" class="method"><a class="src rightside" href="../src/auth/user_provider.rs.html#40">Source</a><h4 class="code-header">fn <a href="#tymethod.authenticate" class="fn">authenticate</a><'life0, 'life1, 'life2, 'async_trait>(
|
||
&'life0 self,
|
||
id: <a class="enum" href="enum.Identity.html" title="enum auth::Identity">Identity</a><'life1>,
|
||
password: <a class="enum" href="enum.Password.html" title="enum auth::Password">Password</a><'life2>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="type" href="error/type.Result.html" title="type auth::error::Result">Result</a><<a class="type" href="type.UserInfoRef.html" title="type auth::UserInfoRef">UserInfoRef</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,
|
||
'life1: 'async_trait,
|
||
'life2: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Checks whether a user is valid and allowed to access the database.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.authorize" class="method"><a class="src rightside" href="../src/auth/user_provider.rs.html#45">Source</a><h4 class="code-header">fn <a href="#tymethod.authorize" class="fn">authorize</a><'life0, 'life1, 'life2, 'life3, 'async_trait>(
|
||
&'life0 self,
|
||
catalog: &'life1 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
schema: &'life2 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
user_info: &'life3 <a class="type" href="type.UserInfoRef.html" title="type auth::UserInfoRef">UserInfoRef</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="type" href="error/type.Result.html" title="type auth::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,
|
||
'life1: 'async_trait,
|
||
'life2: 'async_trait,
|
||
'life3: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Checks whether a connection request
|
||
from a certain user to a certain catalog/schema is legal.
|
||
This method should be called after <a href="trait.UserProvider.html#tymethod.authenticate" title="method auth::UserProvider::authenticate">authenticate()</a>.</p>
|
||
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.auth" class="method"><a class="src rightside" href="../src/auth/user_provider.rs.html#49-59">Source</a><h4 class="code-header">fn <a href="#method.auth" class="fn">auth</a><'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>(
|
||
&'life0 self,
|
||
id: <a class="enum" href="enum.Identity.html" title="enum auth::Identity">Identity</a><'life1>,
|
||
password: <a class="enum" href="enum.Password.html" title="enum auth::Password">Password</a><'life2>,
|
||
catalog: &'life3 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
schema: &'life4 <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.str.html">str</a>,
|
||
) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><dyn <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 = <a class="type" href="error/type.Result.html" title="type auth::error::Result">Result</a><<a class="type" href="type.UserInfoRef.html" title="type auth::UserInfoRef">UserInfoRef</a>>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'async_trait>><div class="where">where
|
||
Self: 'async_trait,
|
||
'life0: 'async_trait,
|
||
'life1: 'async_trait,
|
||
'life2: 'async_trait,
|
||
'life3: 'async_trait,
|
||
'life4: 'async_trait,</div></h4></section></summary><div class="docblock"><p>Combination of <a href="trait.UserProvider.html#tymethod.authenticate" title="method auth::UserProvider::authenticate">authenticate()</a> and <a href="trait.UserProvider.html#tymethod.authorize" title="method auth::UserProvider::authorize">authorize()</a>.
|
||
In most cases it’s preferred for both convenience and performance.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.external" class="method"><a class="src rightside" href="../src/auth/user_provider.rs.html#62-64">Source</a><h4 class="code-header">fn <a href="#method.external" class="fn">external</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether this user provider implementation is backed by an external system.</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-UserProvider-for-StaticUserProvider" class="impl"><a class="src rightside" href="../src/auth/user_provider/static_user_provider.rs.html#73-91">Source</a><a href="#impl-UserProvider-for-StaticUserProvider" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.UserProvider.html" title="trait auth::UserProvider">UserProvider</a> for <a class="struct" href="struct.StaticUserProvider.html" title="struct auth::StaticUserProvider">StaticUserProvider</a></h3></section><section id="impl-UserProvider-for-WatchFileUserProvider" class="impl"><a class="src rightside" href="../src/auth/user_provider/watch_file_user_provider.rs.html#76-90">Source</a><a href="#impl-UserProvider-for-WatchFileUserProvider" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.UserProvider.html" title="trait auth::UserProvider">UserProvider</a> for <a class="struct" href="user_provider/watch_file_user_provider/struct.WatchFileUserProvider.html" title="struct auth::user_provider::watch_file_user_provider::WatchFileUserProvider">WatchFileUserProvider</a></h3></section></div><script src="../trait.impl/auth/user_provider/trait.UserProvider.js" async></script></section></div></main></body></html> |