Files
greptimedb/common_procedure/local/index.html
2025-12-26 03:00:34 +00:00

1 line
7.1 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `local` mod in crate `common_procedure`."><title>common_procedure::local - 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 mod"><!--[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="#">Module local</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"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module local</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></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>Module <span>local</span>&nbsp;<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/local.rs.html#15-1602">Source</a> </span></div><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="runner/index.html" title="mod common_procedure::local::runner">runner</a><span title="Restricted Visibility">&nbsp;🔒</span> </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.DynamicKeyLockGuard.html" title="struct common_procedure::local::DynamicKeyLockGuard">Dynamic<wbr>KeyLock<wbr>Guard</a></dt><dd>A guard for the dynamic key lock.</dd><dt><a class="struct" href="struct.LoadedProcedure.html" title="struct common_procedure::local::LoadedProcedure">Loaded<wbr>Procedure</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Procedure loaded from store.</dd><dt><a class="struct" href="struct.LocalManager.html" title="struct common_procedure::local::LocalManager">Local<wbr>Manager</a></dt><dd>A <a href="../trait.ProcedureManager.html" title="trait common_procedure::ProcedureManager">ProcedureManager</a> that maintains procedure states locally.</dd><dt><a class="struct" href="struct.ManagerConfig.html" title="struct common_procedure::local::ManagerConfig">Manager<wbr>Config</a></dt><dd>Config for <a href="struct.LocalManager.html" title="struct common_procedure::local::LocalManager">LocalManager</a>.</dd><dt><a class="struct" href="struct.ManagerContext.html" title="struct common_procedure::local::ManagerContext">Manager<wbr>Context</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Shared context of the manager.</dd><dt><a class="struct" href="struct.ProcedureMeta.html" title="struct common_procedure::local::ProcedureMeta">Procedure<wbr>Meta</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Shared metadata of a procedure.</dd><dt><a class="struct" href="struct.RemoveOutdatedMetaFunction.html" title="struct common_procedure::local::RemoveOutdatedMetaFunction">Remove<wbr>Outdated<wbr>Meta<wbr>Function</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.META_TTL.html" title="constant common_procedure::local::META_TTL">META_<wbr>TTL</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The expired time of a procedures metadata.</dd></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.PauseAware.html" title="trait common_procedure::local::PauseAware">Pause<wbr>Aware</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.acquire_dynamic_key_lock.html" title="fn common_procedure::local::acquire_dynamic_key_lock">acquire_<wbr>dynamic_<wbr>key_<wbr>lock</a></dt><dd>Acquires a dynamic key lock for the given key.</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.DynamicKeyLock.html" title="type common_procedure::local::DynamicKeyLock">Dynamic<wbr>KeyLock</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>The dynamic lock for procedure execution.</dd><dt><a class="type" href="type.PauseAwareRef.html" title="type common_procedure::local::PauseAwareRef">Pause<wbr>Aware<wbr>Ref</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="type" href="type.ProcedureMetaRef.html" title="type common_procedure::local::ProcedureMetaRef">Procedure<wbr>Meta<wbr>Ref</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Reference counted pointer to <a href="struct.ProcedureMeta.html" title="struct common_procedure::local::ProcedureMeta">ProcedureMeta</a>.</dd></dl></section></div></main></body></html>