mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-01-09 14:52:58 +00:00
25 lines
15 KiB
HTML
25 lines
15 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 `RuntimeTrait` trait in crate `common_runtime`."><title>RuntimeTrait in common_runtime::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="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="#">RuntimeTrait</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.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Runtime<wbr>Trait</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.block_on" title="block_on">block_on</a></li><li><a href="#tymethod.name" title="name">name</a></li><li><a href="#tymethod.spawn" title="spawn">spawn</a></li><li><a href="#tymethod.spawn_blocking" title="spawn_blocking">spawn_blocking</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.builder" title="builder">builder</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In common_<wbr>runtime::<wbr>runtime</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_runtime</a>::<wbr><a href="index.html">runtime</a></div><h1>Trait <span class="trait">Runtime<wbr>Trait</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_runtime/runtime.rs.html#49-75">Source</a> </span></div><pre class="rust item-decl"><code>pub trait RuntimeTrait {
|
||
// Required methods
|
||
fn <a href="#tymethod.spawn" class="fn">spawn</a><F>(&self, future: F) -> <a class="struct" href="../struct.JoinHandle.html" title="struct common_runtime::JoinHandle">JoinHandle</a><F::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>> <a href="#" class="tooltip" data-notable-ty="JoinHandle<F::Output>">ⓘ</a>
|
||
<span class="where">where F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,
|
||
F::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.spawn_blocking" class="fn">spawn_blocking</a><F, R>(&self, func: F) -> <a class="struct" href="../struct.JoinHandle.html" title="struct common_runtime::JoinHandle">JoinHandle</a><R> <a href="#" class="tooltip" data-notable-ty="JoinHandle<R>">ⓘ</a>
|
||
<span class="where">where F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> R + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,
|
||
R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static</span>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.block_on" class="fn">block_on</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>(&self, future: F) -> F::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>;
|
||
<span class="item-spacer"></span> 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>;
|
||
|
||
// Provided method
|
||
fn <a href="#method.builder" class="fn">builder</a>() -> <a class="struct" href="struct.Builder.html" title="struct common_runtime::runtime::Builder">Builder</a> { ... }
|
||
}</code></pre><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.spawn" class="method"><a class="src rightside" href="../../src/common_runtime/runtime.rs.html#58-61">Source</a><h4 class="code-header">fn <a href="#tymethod.spawn" class="fn">spawn</a><F>(&self, future: F) -> <a class="struct" href="../struct.JoinHandle.html" title="struct common_runtime::JoinHandle">JoinHandle</a><F::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>> <a href="#" class="tooltip" data-notable-ty="JoinHandle<F::Output>">ⓘ</a><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,
|
||
F::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</div></h4></section></summary><div class="docblock"><p>Spawn a future and execute it in this thread pool</p>
|
||
<p>Similar to tokio::runtime::Runtime::spawn()</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.spawn_blocking" class="method"><a class="src rightside" href="../../src/common_runtime/runtime.rs.html#65-68">Source</a><h4 class="code-header">fn <a href="#tymethod.spawn_blocking" class="fn">spawn_blocking</a><F, R>(&self, func: F) -> <a class="struct" href="../struct.JoinHandle.html" title="struct common_runtime::JoinHandle">JoinHandle</a><R> <a href="#" class="tooltip" data-notable-ty="JoinHandle<R>">ⓘ</a><div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> R + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,
|
||
R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</div></h4></section></summary><div class="docblock"><p>Run the provided function on an executor dedicated to blocking
|
||
operations.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.block_on" class="method"><a class="src rightside" href="../../src/common_runtime/runtime.rs.html#71">Source</a><h4 class="code-header">fn <a href="#tymethod.block_on" class="fn">block_on</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>(&self, future: F) -> F::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a></h4></section></summary><div class="docblock"><p>Run a future to complete, this is the runtime’s entry point</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.name" class="method"><a class="src rightside" href="../../src/common_runtime/runtime.rs.html#74">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></summary><div class="docblock"><p>Get the name of the runtime</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.builder" class="method"><a class="src rightside" href="../../src/common_runtime/runtime.rs.html#51-53">Source</a><h4 class="code-header">fn <a href="#method.builder" class="fn">builder</a>() -> <a class="struct" href="struct.Builder.html" title="struct common_runtime::runtime::Builder">Builder</a></h4></section></summary><div class="docblock"><p>Get a runtime builder</p>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/nightly/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-RuntimeTrait-for-DefaultRuntime" class="impl"><a class="src rightside" href="../../src/common_runtime/runtime_default.rs.html#43-77">Source</a><a href="#impl-RuntimeTrait-for-DefaultRuntime" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RuntimeTrait.html" title="trait common_runtime::runtime::RuntimeTrait">RuntimeTrait</a> for <a class="struct" href="../runtime_default/struct.DefaultRuntime.html" title="struct common_runtime::runtime_default::DefaultRuntime">DefaultRuntime</a></h3></section><section id="impl-RuntimeTrait-for-ThrottleableRuntime" class="impl"><a class="src rightside" href="../../src/common_runtime/runtime_throttleable.rs.html#80-115">Source</a><a href="#impl-RuntimeTrait-for-ThrottleableRuntime" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.RuntimeTrait.html" title="trait common_runtime::runtime::RuntimeTrait">RuntimeTrait</a> for <a class="struct" href="../runtime_throttleable/struct.ThrottleableRuntime.html" title="struct common_runtime::runtime_throttleable::ThrottleableRuntime">ThrottleableRuntime</a></h3></section></div><script src="../../trait.impl/common_runtime/runtime/trait.RuntimeTrait.js" async></script><script type="text/json" id="notable-traits-data">{"JoinHandle<F::Output>":"<h3>Notable traits for <code><a class=\"struct\" href=\"../struct.JoinHandle.html\" title=\"struct common_runtime::JoinHandle\">JoinHandle</a><T></code></h3><pre><code><div class=\"where\">impl<T> <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><T></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><T, <a class=\"struct\" href=\"../struct.JoinError.html\" title=\"struct common_runtime::JoinError\">JoinError</a>>;</div>","JoinHandle<R>":"<h3>Notable traits for <code><a class=\"struct\" href=\"../struct.JoinHandle.html\" title=\"struct common_runtime::JoinHandle\">JoinHandle</a><T></code></h3><pre><code><div class=\"where\">impl<T> <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><T></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><T, <a class=\"struct\" href=\"../struct.JoinError.html\" title=\"struct common_runtime::JoinError\">JoinError</a>>;</div>"}</script></section></div></main></body></html> |