mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2025-12-22 22:20:02 +00:00
2 lines
13 KiB
HTML
2 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="Common traits and structures for the procedure framework."><title>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="../crates.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 mod crate"><!--[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="#">Crate common_procedure</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.3</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>common_<wbr>procedure</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/lib.rs.html#15-39">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Common traits and structures for the procedure framework.</p>
|
|
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.Error"><code>pub use crate::error::<a class="enum" href="error/enum.Error.html" title="enum common_procedure::error::Error">Error</a>;</code></dt><dt id="reexport.Result"><code>pub use crate::error::<a class="type" href="error/type.Result.html" title="type common_procedure::error::Result">Result</a>;</code></dt><dt id="reexport.ProcedureEvent"><code>pub use crate::event::<a class="struct" href="event/struct.ProcedureEvent.html" title="struct common_procedure::event::ProcedureEvent">ProcedureEvent</a>;</code></dt><dt id="reexport.Watcher"><code>pub use crate::watcher::<a class="type" href="watcher/type.Watcher.html" title="type common_procedure::watcher::Watcher">Watcher</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="error/index.html" title="mod common_procedure::error">error</a></dt><dt><a class="mod" href="event/index.html" title="mod common_procedure::event">event</a></dt><dt><a class="mod" href="local/index.html" title="mod common_procedure::local">local</a></dt><dt><a class="mod" href="options/index.html" title="mod common_procedure::options">options</a></dt><dd>Common traits and structures for the procedure framework.</dd><dt><a class="mod" href="procedure/index.html" title="mod common_procedure::procedure">procedure</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="mod" href="rwlock/index.html" title="mod common_procedure::rwlock">rwlock</a></dt><dt><a class="mod" href="store/index.html" title="mod common_procedure::store">store</a></dt><dt><a class="mod" href="test_util/index.html" title="mod common_procedure::test_util">test_<wbr>util</a></dt><dt><a class="mod" href="watcher/index.html" title="mod common_procedure::watcher">watcher</a></dt></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Context.html" title="struct common_procedure::Context">Context</a></dt><dd>Procedure execution context.</dd><dt><a class="struct" href="struct.LockKey.html" title="struct common_procedure::LockKey">LockKey</a></dt><dd>Keys to identify required locks.</dd><dt><a class="struct" href="struct.ParseIdError.html" title="struct common_procedure::ParseIdError">Parse<wbr>IdError</a></dt><dt><a class="struct" href="struct.PoisonKey.html" title="struct common_procedure::PoisonKey">Poison<wbr>Key</a></dt><dt><a class="struct" href="struct.PoisonKeys.html" title="struct common_procedure::PoisonKeys">Poison<wbr>Keys</a></dt><dd>A collection of <a href="struct.PoisonKey.html" title="struct common_procedure::PoisonKey">PoisonKey</a>s.</dd><dt><a class="struct" href="struct.ProcedureId.html" title="struct common_procedure::ProcedureId">Procedure<wbr>Id</a></dt><dd>Unique id for <a href="trait.Procedure.html" title="trait common_procedure::Procedure">Procedure</a>.</dd><dt><a class="struct" href="struct.ProcedureInfo.html" title="struct common_procedure::ProcedureInfo">Procedure<wbr>Info</a></dt><dt><a class="struct" href="struct.ProcedureWithId.html" title="struct common_procedure::ProcedureWithId">Procedure<wbr>With<wbr>Id</a></dt><dd>A procedure with specific id.</dd><dt><a class="struct" href="struct.UserMetadata.html" title="struct common_procedure::UserMetadata">User<wbr>Metadata</a></dt><dd>The user metadata injected by the procedure caller. It can be used to emit events to the event recorder.</dd></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.ProcedureState.html" title="enum common_procedure::ProcedureState">Procedure<wbr>State</a></dt><dd>State of a submitted procedure.</dd><dt><a class="enum" href="enum.Status.html" title="enum common_procedure::Status">Status</a></dt><dd>Procedure execution status.</dd><dt><a class="enum" href="enum.StringKey.html" title="enum common_procedure::StringKey">String<wbr>Key</a></dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.ContextProvider.html" title="trait common_procedure::ContextProvider">Context<wbr>Provider</a></dt><dd><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>.</dd><dt><a class="trait" href="trait.Procedure.html" title="trait common_procedure::Procedure">Procedure</a></dt><dd>A <code>Procedure</code> represents an operation or a set of operations to be performed step-by-step.</dd><dt><a class="trait" href="trait.ProcedureManager.html" title="trait common_procedure::ProcedureManager">Procedure<wbr>Manager</a></dt><dd><code>ProcedureManager</code> executes <a href="trait.Procedure.html" title="trait common_procedure::Procedure">Procedure</a> submitted to it.</dd></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.BoxedProcedure.html" title="type common_procedure::BoxedProcedure">Boxed<wbr>Procedure</a></dt><dd>Boxed <a href="trait.Procedure.html" title="trait common_procedure::Procedure">Procedure</a>.</dd><dt><a class="type" href="type.BoxedProcedureLoader.html" title="type common_procedure::BoxedProcedureLoader">Boxed<wbr>Procedure<wbr>Loader</a></dt><dd>Loader to recover the <a href="trait.Procedure.html" title="trait common_procedure::Procedure">Procedure</a> instance from serialized data.</dd><dt><a class="type" href="type.ContextProviderRef.html" title="type common_procedure::ContextProviderRef">Context<wbr>Provider<wbr>Ref</a></dt><dd>Reference-counted pointer to <a href="trait.ContextProvider.html" title="trait common_procedure::ContextProvider">ContextProvider</a>.</dd><dt><a class="type" href="type.Output.html" title="type common_procedure::Output">Output</a></dt><dt><a class="type" href="type.ProcedureManagerRef.html" title="type common_procedure::ProcedureManagerRef">Procedure<wbr>Manager<wbr>Ref</a></dt><dd>Ref-counted pointer to the <a href="trait.ProcedureManager.html" title="trait common_procedure::ProcedureManager">ProcedureManager</a>.</dd></dl><script type="text/json" id="notable-traits-data">{"&[u8]":"<h3>Notable traits for <code>&[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for &[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>","<Arc<S> as Service<Request>>::Future":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div>","<Arc<W> as MakeWriter<'a>>::Writer":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></code></h3><pre><code><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div><div class=\"where\">impl <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/sync/struct.Arc.html\" title=\"struct alloc::sync::Arc\">Arc</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/std/fs/struct.File.html\" title=\"struct std::fs::File\">File</a>></div>","Vec<u8>":"<h3>Notable traits for <code><a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A></code></h3><pre><code><div class=\"where\">impl<A> <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/std/io/trait.Write.html\" title=\"trait std::io::Write\">Write</a> for <a class=\"struct\" href=\"https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A><div class=\"where\">where\n A: <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/alloc/trait.Allocator.html\" title=\"trait core::alloc::Allocator\">Allocator</a>,</div></div>"}</script></section></div></main></body></html> |