mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-07 13:52:59 +00:00
59 lines
16 KiB
HTML
59 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="ContextProvider provides information about procedures in the ProcedureManager."><title>ContextProvider in common_procedure - 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="common_procedure" 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="#">ContextProvider</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_procedure/index.html">common_<wbr>procedure</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="#">Context<wbr>Provider</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.acquire_lock" title="acquire_lock">acquire_lock</a></li><li><a href="#tymethod.procedure_state" title="procedure_state">procedure_state</a></li><li><a href="#tymethod.procedure_state_receiver" title="procedure_state_receiver">procedure_state_receiver</a></li><li><a href="#tymethod.try_put_poison" title="try_put_poison">try_put_poison</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 common_<wbr>procedure</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">common_procedure</a></div><h1>Trait <span class="trait">Context<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/common_procedure/procedure.rs.html#149-166">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ContextProvider: <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.procedure_state" class="fn">procedure_state</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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 common_procedure::error::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="enum" href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">ProcedureState</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</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.procedure_state_receiver" class="fn">procedure_state_receiver</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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 common_procedure::error::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><Receiver<<a class="enum" href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">ProcedureState</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</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.try_put_poison" class="fn">try_put_poison</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
key: &'life1 <a class="struct" href="struct.PoisonKey.html" title="struct common_procedure::PoisonKey">PoisonKey</a>,
|
|
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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 common_procedure::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</span>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.acquire_lock" class="fn">acquire_lock</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
key: &'life1 <a class="enum" href="enum.StringKey.html" title="enum common_procedure::StringKey">StringKey</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="struct" href="local/struct.DynamicKeyLockGuard.html" title="struct common_procedure::local::DynamicKeyLockGuard">DynamicKeyLockGuard</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</span>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><a href="trait.ContextProvider.html" title="trait common_procedure::ContextProvider">ContextProvider</a> provides information about procedures in the <a href="trait.ProcedureManager.html" title="trait common_procedure::ProcedureManager">ProcedureManager</a>.</p>
|
|
</div></details><h2 id="required-methods" class="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.procedure_state" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#151">Source</a><h4 class="code-header">fn <a href="#tymethod.procedure_state" class="fn">procedure_state</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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 common_procedure::error::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="enum" href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">ProcedureState</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,</div></h4></section></summary><div class="docblock"><p>Query the procedure state.</p>
|
|
</div></details><section id="tymethod.procedure_state_receiver" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#153-156">Source</a><h4 class="code-header">fn <a href="#tymethod.procedure_state_receiver" class="fn">procedure_state_receiver</a><'life0, 'async_trait>(
|
|
&'life0 self,
|
|
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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 common_procedure::error::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><Receiver<<a class="enum" href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">ProcedureState</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,</div></h4></section><details class="toggle method-toggle" open><summary><section id="tymethod.try_put_poison" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#162">Source</a><h4 class="code-header">fn <a href="#tymethod.try_put_poison" class="fn">try_put_poison</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
key: &'life1 <a class="struct" href="struct.PoisonKey.html" title="struct common_procedure::PoisonKey">PoisonKey</a>,
|
|
procedure_id: <a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">ProcedureId</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 common_procedure::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,</div></h4></section></summary><div class="docblock"><p>Try to put a poison key for a procedure.</p>
|
|
<p>This method is used to mark a resource as being operated on by a procedure.
|
|
If the poison key already exists with a different value, the operation will fail.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.acquire_lock" class="method"><a class="src rightside" href="../src/common_procedure/procedure.rs.html#165">Source</a><h4 class="code-header">fn <a href="#tymethod.acquire_lock" class="fn">acquire_lock</a><'life0, 'life1, 'async_trait>(
|
|
&'life0 self,
|
|
key: &'life1 <a class="enum" href="enum.StringKey.html" title="enum common_procedure::StringKey">StringKey</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="struct" href="local/struct.DynamicKeyLockGuard.html" title="struct common_procedure::local::DynamicKeyLockGuard">DynamicKeyLockGuard</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,</div></h4></section></summary><div class="docblock"><p>Acquires a key lock for the procedure.</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-ContextProvider-for-ManagerContext" class="impl"><a class="src rightside" href="../src/common_procedure/local.rs.html#264-301">Source</a><a href="#impl-ContextProvider-for-ManagerContext" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ContextProvider.html" title="trait common_procedure::ContextProvider">ContextProvider</a> for <a class="struct" href="local/struct.ManagerContext.html" title="struct common_procedure::local::ManagerContext">ManagerContext</a></h3></section></div><script src="../trait.impl/common_procedure/procedure/trait.ContextProvider.js" async></script></section></div></main></body></html> |