mirror of
https://github.com/maplibre/maplibre-rs.git
synced 2025-12-08 19:05:57 +00:00
53 lines
18 KiB
HTML
53 lines
18 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="APCs define an interface for performing work asynchronously. This work can be implemented through procedures which can be called asynchronously, hence the name AsyncProcedureCall or APC for short."><title>AsyncProcedureCall in maplibre::io::apc - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="maplibre" data-themes="" data-resource-suffix="" data-rustdoc-version="1.73.0 (cc66ad468 2023-10-03)" data-channel="1.73.0" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-1596385f77d47ef2.css" data-theme-dark-css="dark-0a43001d3fc2282c.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../../static.files/light-1596385f77d47ef2.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../../static.files/dark-0a43001d3fc2282c.css"><link rel="stylesheet" href="../../../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="logo-container" href="../../../maplibre/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../../maplibre/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">AsyncProcedureCall</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Context">Context</a></li><li><a href="#associatedtype.ReceiveIterator">ReceiveIterator</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.call">call</a></li><li><a href="#tymethod.receive">receive</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In maplibre::io::apc</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Trait <a href="../../index.html">maplibre</a>::<wbr><a href="../index.html">io</a>::<wbr><a href="index.html">apc</a>::<wbr><a class="trait" href="#">AsyncProcedureCall</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/maplibre/io/apc.rs.html#167-182">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait AsyncProcedureCall<K: <a class="trait" href="../../environment/trait.OffscreenKernelEnvironment.html" title="trait maplibre::environment::OffscreenKernelEnvironment">OffscreenKernelEnvironment</a>>: 'static {
|
||
type <a href="#associatedtype.Context" class="associatedtype">Context</a>: <a class="trait" href="trait.Context.html" title="trait maplibre::io::apc::Context">Context</a> + <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>;
|
||
type <a href="#associatedtype.ReceiveIterator" class="associatedtype">ReceiveIterator</a><F: <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.73.0/std/primitive.bool.html">bool</a>>: <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>>;
|
||
|
||
// Required methods
|
||
fn <a href="#tymethod.receive" class="fn">receive</a><F: <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.73.0/std/primitive.bool.html">bool</a>>(
|
||
&self,
|
||
filter: F
|
||
) -> Self::<a class="associatedtype" href="trait.AsyncProcedureCall.html#associatedtype.ReceiveIterator" title="type maplibre::io::apc::AsyncProcedureCall::ReceiveIterator">ReceiveIterator</a><F>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.call" class="fn">call</a>(
|
||
&self,
|
||
input: <a class="enum" href="enum.Input.html" title="enum maplibre::io::apc::Input">Input</a>,
|
||
procedure: <a class="type" href="type.AsyncProcedure.html" title="type maplibre::io::apc::AsyncProcedure">AsyncProcedure</a><K, Self::<a class="associatedtype" href="trait.AsyncProcedureCall.html#associatedtype.Context" title="type maplibre::io::apc::AsyncProcedureCall::Context">Context</a>>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.73.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.73.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.CallError.html" title="enum maplibre::io::apc::CallError">CallError</a>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>APCs define an interface for performing work asynchronously.
|
||
This work can be implemented through procedures which can be called asynchronously, hence the
|
||
name AsyncProcedureCall or APC for short.</p>
|
||
<p>APCs serve as an abstraction for doing work on a separate thread, and then getting responses
|
||
back. An asynchronous procedure call can for example be performed by using message passing. In
|
||
fact this could theoretically work over a network socket.</p>
|
||
<p>It is possible to schedule work on a remote host by calling <a href="trait.AsyncProcedureCall.html#tymethod.call" title="method maplibre::io::apc::AsyncProcedureCall::call"><code>AsyncProcedureCall::call()</code></a>
|
||
and getting the results back by calling the non-blocking function
|
||
<a href="trait.AsyncProcedureCall.html#tymethod.receive" title="method maplibre::io::apc::AsyncProcedureCall::receive"><code>AsyncProcedureCall::receive()</code></a>. The <a href="trait.AsyncProcedureCall.html#tymethod.receive" title="method maplibre::io::apc::AsyncProcedureCall::receive"><code>AsyncProcedureCall::receive()</code></a> function returns a
|
||
struct which implements [<code>Transferables</code>].</p>
|
||
<h3 id="transferables"><a href="#transferables">Transferables</a></h3>
|
||
<p>Based on whether the current platform supports shared-memory or not, the implementation of APCs
|
||
might want to send the whole data from the worker to the caller back or just pointers to that
|
||
data. The [<code>Transferables</code>] trait allows developers to define that and use different data
|
||
layouts for different platforms.</p>
|
||
<h3 id="message-passing-vs-apc"><a href="#message-passing-vs-apc">Message Passing vs APC</a></h3>
|
||
<p>One might wonder why this is called <a href="trait.AsyncProcedureCall.html" title="trait maplibre::io::apc::AsyncProcedureCall"><code>AsyncProcedureCall</code></a> instead of <code>MessagePassingInterface</code>.
|
||
The reason for this is quite simple. We are actually referencing and calling procedures which
|
||
are defined in different threads, processes or hosts. That means, that an <a href="trait.AsyncProcedureCall.html" title="trait maplibre::io::apc::AsyncProcedureCall"><code>AsyncProcedureCall</code></a>
|
||
is actually distinct from a <code>MessagePassingInterface</code>.</p>
|
||
<h3 id="current-implementations"><a href="#current-implementations">Current Implementations</a></h3>
|
||
<p>We currently have two implementation for APCs. One uses the Tokio async runtime on native
|
||
targets in <a href="struct.SchedulerAsyncProcedureCall.html" title="struct maplibre::io::apc::SchedulerAsyncProcedureCall"><code>SchedulerAsyncProcedureCall</code></a>.
|
||
For the web we implemented an alternative way to call APCs which is called
|
||
[<code>PassingAsyncProcedureCall</code>]. This implementation does not depend on shared-memory compared to
|
||
<a href="struct.SchedulerAsyncProcedureCall.html" title="struct maplibre::io::apc::SchedulerAsyncProcedureCall"><code>SchedulerAsyncProcedureCall</code></a>. In fact, on the web we are currently not depending on
|
||
shared-memory because that feature is hidden behind feature flags in browsers
|
||
(see <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer">here</a>).</p>
|
||
</div></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.Context" class="method"><a class="src rightside" href="../../../src/maplibre/io/apc.rs.html#168">source</a><h4 class="code-header">type <a href="#associatedtype.Context" class="associatedtype">Context</a>: <a class="trait" href="trait.Context.html" title="trait maplibre::io::apc::Context">Context</a> + <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a></h4></section><section id="associatedtype.ReceiveIterator" class="method"><a class="src rightside" href="../../../src/maplibre/io/apc.rs.html#170">source</a><h4 class="code-header">type <a href="#associatedtype.ReceiveIterator" class="associatedtype">ReceiveIterator</a><F: <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.73.0/std/primitive.bool.html">bool</a>>: <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = <a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>></h4></section></div><h2 id="required-methods" class="small-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.receive" class="method"><a class="src rightside" href="../../../src/maplibre/io/apc.rs.html#173">source</a><h4 class="code-header">fn <a href="#tymethod.receive" class="fn">receive</a><F: <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.73.0/std/primitive.bool.html">bool</a>>(
|
||
&self,
|
||
filter: F
|
||
) -> Self::<a class="associatedtype" href="trait.AsyncProcedureCall.html#associatedtype.ReceiveIterator" title="type maplibre::io::apc::AsyncProcedureCall::ReceiveIterator">ReceiveIterator</a><F></h4></section></summary><div class="docblock"><p>Try to receive a message non-blocking.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.call" class="method"><a class="src rightside" href="../../../src/maplibre/io/apc.rs.html#177-181">source</a><h4 class="code-header">fn <a href="#tymethod.call" class="fn">call</a>(
|
||
&self,
|
||
input: <a class="enum" href="enum.Input.html" title="enum maplibre::io::apc::Input">Input</a>,
|
||
procedure: <a class="type" href="type.AsyncProcedure.html" title="type maplibre::io::apc::AsyncProcedure">AsyncProcedure</a><K, Self::<a class="associatedtype" href="trait.AsyncProcedureCall.html#associatedtype.Context" title="type maplibre::io::apc::AsyncProcedureCall::Context">Context</a>>
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.73.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.73.0/std/primitive.unit.html">()</a>, <a class="enum" href="enum.CallError.html" title="enum maplibre::io::apc::CallError">CallError</a>></h4></section></summary><div class="docblock"><p>Call an <a href="type.AsyncProcedure.html" title="type maplibre::io::apc::AsyncProcedure"><code>AsyncProcedure</code></a> using some <a href="enum.Input.html" title="enum maplibre::io::apc::Input"><code>Input</code></a>. This function is non-blocking and
|
||
returns immediately.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-AsyncProcedureCall%3CK%3E-for-SchedulerAsyncProcedureCall%3CK,+S%3E" class="impl"><a class="src rightside" href="../../../src/maplibre/io/apc.rs.html#215-269">source</a><a href="#impl-AsyncProcedureCall%3CK%3E-for-SchedulerAsyncProcedureCall%3CK,+S%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="../../environment/trait.OffscreenKernelEnvironment.html" title="trait maplibre::environment::OffscreenKernelEnvironment">OffscreenKernelEnvironment</a>, S: <a class="trait" href="../scheduler/trait.Scheduler.html" title="trait maplibre::io::scheduler::Scheduler">Scheduler</a>> <a class="trait" href="trait.AsyncProcedureCall.html" title="trait maplibre::io::apc::AsyncProcedureCall">AsyncProcedureCall</a><K> for <a class="struct" href="struct.SchedulerAsyncProcedureCall.html" title="struct maplibre::io::apc::SchedulerAsyncProcedureCall">SchedulerAsyncProcedureCall</a><K, S></h3></section></summary><div class="impl-items"><section id="associatedtype.Context-1" class="associatedtype trait-impl"><a href="#associatedtype.Context-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Context" class="associatedtype">Context</a> = <a class="struct" href="struct.SchedulerContext.html" title="struct maplibre::io::apc::SchedulerContext">SchedulerContext</a></h4></section><section id="associatedtype.ReceiveIterator-1" class="associatedtype trait-impl"><a href="#associatedtype.ReceiveIterator-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.ReceiveIterator" class="associatedtype">ReceiveIterator</a><F: <a class="trait" href="https://doc.rust-lang.org/1.73.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(&<a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.73.0/std/primitive.bool.html">bool</a>> = <a class="struct" href="https://doc.rust-lang.org/1.73.0/alloc/vec/into_iter/struct.IntoIter.html" title="struct alloc::vec::into_iter::IntoIter">IntoIter</a><<a class="struct" href="struct.Message.html" title="struct maplibre::io::apc::Message">Message</a>, <a class="struct" href="https://doc.rust-lang.org/1.73.0/alloc/alloc/struct.Global.html" title="struct alloc::alloc::Global">Global</a>></h4></section></div></details></div><script src="../../../implementors/maplibre/io/apc/trait.AsyncProcedureCall.js" async></script></section></div></main></body></html> |