Files
greptimedb/common_runtime/index.html
2025-12-18 14:53:29 +00:00

1 line
11 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 `common_runtime` crate."><title>common_runtime - 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_runtime" 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_runtime</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../common_runtime/index.html">common_<wbr>runtime</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="#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>runtime</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_runtime/lib.rs.html#15-30">Source</a> </span></div><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.block_on_compact"><code>pub use global::<a class="fn" href="global/fn.block_on_compact.html" title="fn common_runtime::global::block_on_compact">block_on_compact</a>;</code></dt><dt id="reexport.block_on_global"><code>pub use global::<a class="fn" href="global/fn.block_on_global.html" title="fn common_runtime::global::block_on_global">block_on_global</a>;</code></dt><dt id="reexport.compact_runtime"><code>pub use global::<a class="fn" href="global/fn.compact_runtime.html" title="fn common_runtime::global::compact_runtime">compact_runtime</a>;</code></dt><dt id="reexport.create_runtime"><code>pub use global::<a class="fn" href="global/fn.create_runtime.html" title="fn common_runtime::global::create_runtime">create_runtime</a>;</code></dt><dt id="reexport.global_runtime"><code>pub use global::<a class="fn" href="global/fn.global_runtime.html" title="fn common_runtime::global::global_runtime">global_runtime</a>;</code></dt><dt id="reexport.init_global_runtimes"><code>pub use global::<a class="fn" href="global/fn.init_global_runtimes.html" title="fn common_runtime::global::init_global_runtimes">init_global_runtimes</a>;</code></dt><dt id="reexport.spawn_blocking_compact"><code>pub use global::<a class="fn" href="global/fn.spawn_blocking_compact.html" title="fn common_runtime::global::spawn_blocking_compact">spawn_blocking_compact</a>;</code></dt><dt id="reexport.spawn_blocking_global"><code>pub use global::<a class="fn" href="global/fn.spawn_blocking_global.html" title="fn common_runtime::global::spawn_blocking_global">spawn_blocking_global</a>;</code></dt><dt id="reexport.spawn_blocking_hb"><code>pub use global::<a class="fn" href="global/fn.spawn_blocking_hb.html" title="fn common_runtime::global::spawn_blocking_hb">spawn_blocking_hb</a>;</code></dt><dt id="reexport.spawn_compact"><code>pub use global::<a class="fn" href="global/fn.spawn_compact.html" title="fn common_runtime::global::spawn_compact">spawn_compact</a>;</code></dt><dt id="reexport.spawn_global"><code>pub use global::<a class="fn" href="global/fn.spawn_global.html" title="fn common_runtime::global::spawn_global">spawn_global</a>;</code></dt><dt id="reexport.spawn_hb"><code>pub use global::<a class="fn" href="global/fn.spawn_hb.html" title="fn common_runtime::global::spawn_hb">spawn_hb</a>;</code></dt><dt id="reexport.Builder"><code>pub use crate::runtime::<a class="struct" href="runtime/struct.Builder.html" title="struct common_runtime::runtime::Builder">Builder</a>;</code></dt><dt id="reexport.Runtime"><code>pub use crate::runtime::<a class="type" href="runtime/type.Runtime.html" title="type common_runtime::runtime::Runtime">Runtime</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_runtime::error">error</a></dt><dt><a class="mod" href="global/index.html" title="mod common_runtime::global">global</a></dt><dd>Global runtimes</dd><dt><a class="mod" href="metrics/index.html" title="mod common_runtime::metrics">metrics</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Runtime metrics</dd><dt><a class="mod" href="repeated_task/index.html" title="mod common_runtime::repeated_task">repeated_<wbr>task</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="mod" href="runtime/index.html" title="mod common_runtime::runtime">runtime</a></dt><dt><a class="mod" href="runtime_default/index.html" title="mod common_runtime::runtime_default">runtime_<wbr>default</a></dt><dt><a class="mod" href="runtime_throttleable/index.html" title="mod common_runtime::runtime_throttleable">runtime_<wbr>throttleable</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.JoinError.html" title="struct common_runtime::JoinError">Join<wbr>Error</a></dt><dd>Task failed to execute to completion.</dd><dt><a class="struct" href="struct.JoinHandle.html" title="struct common_runtime::JoinHandle">Join<wbr>Handle</a></dt><dd>An owned permission to join on a task (await its termination).</dd><dt><a class="struct" href="struct.RepeatedTask.html" title="struct common_runtime::RepeatedTask">Repeated<wbr>Task</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.TaskFunction.html" title="trait common_runtime::TaskFunction">Task<wbr>Function</a></dt><dd>Task to execute repeatedly.</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.BoxedTaskFunction.html" title="type common_runtime::BoxedTaskFunction">Boxed<wbr>Task<wbr>Function</a></dt></dl><script type="text/json" id="notable-traits-data">{"&[u8]":"<h3>Notable traits for <code>&amp;[<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 &amp;[<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>]</div>","JoinHandle<F::Output>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.JoinHandle.html\" title=\"struct common_runtime::JoinHandle\">JoinHandle</a>&lt;T&gt;</code></h3><pre><code><div class=\"where\">impl&lt;T&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a> for <a class=\"struct\" href=\"struct.JoinHandle.html\" title=\"struct common_runtime::JoinHandle\">JoinHandle</a>&lt;T&gt;</div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = <a class=\"enum\" href=\"https://doc.rust-lang.org/nightly/core/result/enum.Result.html\" title=\"enum core::result::Result\">Result</a>&lt;T, <a class=\"struct\" href=\"struct.JoinError.html\" title=\"struct common_runtime::JoinError\">JoinError</a>&gt;;</div>","JoinHandle<R>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.JoinHandle.html\" title=\"struct common_runtime::JoinHandle\">JoinHandle</a>&lt;T&gt;</code></h3><pre><code><div class=\"where\">impl&lt;T&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a> for <a class=\"struct\" href=\"struct.JoinHandle.html\" title=\"struct common_runtime::JoinHandle\">JoinHandle</a>&lt;T&gt;</div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = <a class=\"enum\" href=\"https://doc.rust-lang.org/nightly/core/result/enum.Result.html\" title=\"enum core::result::Result\">Result</a>&lt;T, <a class=\"struct\" href=\"struct.JoinError.html\" title=\"struct common_runtime::JoinError\">JoinError</a>&gt;;</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>&lt;<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;A&gt; <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>&lt;<a class=\"primitive\" href=\"https://doc.rust-lang.org/nightly/std/primitive.u8.html\">u8</a>, A&gt;<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>