mirror of
https://github.com/maplibre/maplibre-rs.git
synced 2025-12-08 19:05:57 +00:00
14 lines
9.9 KiB
HTML
14 lines
9.9 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="The environment defines which types must be injected into maplibre at compile time. Essentially, this trait implements the dependency injection design pattern. By instantiating this trait at compile time with concrete types, it is possible to create different compile-time instances of maplibre."><title>Environment in maplibre::environment - 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="#">Environment</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.AsyncProcedureCall">AsyncProcedureCall</a></li><li><a href="#associatedtype.HttpClient">HttpClient</a></li><li><a href="#associatedtype.MapWindowConfig">MapWindowConfig</a></li><li><a href="#associatedtype.OffscreenKernelEnvironment">OffscreenKernelEnvironment</a></li><li><a href="#associatedtype.Scheduler">Scheduler</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In maplibre::environment</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">environment</a>::<wbr><a class="trait" href="#">Environment</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/environment.rs.html#18-28">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Environment: 'static {
|
||
type <a href="#associatedtype.MapWindowConfig" class="associatedtype">MapWindowConfig</a>: <a class="trait" href="../window/trait.MapWindowConfig.html" title="trait maplibre::window::MapWindowConfig">MapWindowConfig</a>;
|
||
type <a href="#associatedtype.AsyncProcedureCall" class="associatedtype">AsyncProcedureCall</a>: <a class="trait" href="../io/apc/trait.AsyncProcedureCall.html" title="trait maplibre::io::apc::AsyncProcedureCall">AsyncProcedureCall</a><Self::<a class="associatedtype" href="trait.Environment.html#associatedtype.OffscreenKernelEnvironment" title="type maplibre::environment::Environment::OffscreenKernelEnvironment">OffscreenKernelEnvironment</a>>;
|
||
type <a href="#associatedtype.Scheduler" class="associatedtype">Scheduler</a>: <a class="trait" href="../io/scheduler/trait.Scheduler.html" title="trait maplibre::io::scheduler::Scheduler">Scheduler</a>;
|
||
type <a href="#associatedtype.HttpClient" class="associatedtype">HttpClient</a>: <a class="trait" href="../io/source_client/trait.HttpClient.html" title="trait maplibre::io::source_client::HttpClient">HttpClient</a>;
|
||
type <a href="#associatedtype.OffscreenKernelEnvironment" class="associatedtype">OffscreenKernelEnvironment</a>: <a class="trait" href="trait.OffscreenKernelEnvironment.html" title="trait maplibre::environment::OffscreenKernelEnvironment">OffscreenKernelEnvironment</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The environment defines which types must be injected into maplibre at compile time.
|
||
Essentially, this trait implements the
|
||
<a href="https://en.wikipedia.org/wiki/Dependency_injection">dependency injection</a> design pattern.
|
||
By instantiating this trait at compile time with concrete types, it is possible to create
|
||
different compile-time instances of maplibre.</p>
|
||
<p>For example it is possible to change the way tasks are scheduled. It is also possible to change
|
||
the HTTP implementation for fetching tiles over the network.</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.MapWindowConfig" class="method"><a class="src rightside" href="../../src/maplibre/environment.rs.html#19">source</a><h4 class="code-header">type <a href="#associatedtype.MapWindowConfig" class="associatedtype">MapWindowConfig</a>: <a class="trait" href="../window/trait.MapWindowConfig.html" title="trait maplibre::window::MapWindowConfig">MapWindowConfig</a></h4></section><section id="associatedtype.AsyncProcedureCall" class="method"><a class="src rightside" href="../../src/maplibre/environment.rs.html#21">source</a><h4 class="code-header">type <a href="#associatedtype.AsyncProcedureCall" class="associatedtype">AsyncProcedureCall</a>: <a class="trait" href="../io/apc/trait.AsyncProcedureCall.html" title="trait maplibre::io::apc::AsyncProcedureCall">AsyncProcedureCall</a><Self::<a class="associatedtype" href="trait.Environment.html#associatedtype.OffscreenKernelEnvironment" title="type maplibre::environment::Environment::OffscreenKernelEnvironment">OffscreenKernelEnvironment</a>></h4></section><section id="associatedtype.Scheduler" class="method"><a class="src rightside" href="../../src/maplibre/environment.rs.html#23">source</a><h4 class="code-header">type <a href="#associatedtype.Scheduler" class="associatedtype">Scheduler</a>: <a class="trait" href="../io/scheduler/trait.Scheduler.html" title="trait maplibre::io::scheduler::Scheduler">Scheduler</a></h4></section><section id="associatedtype.HttpClient" class="method"><a class="src rightside" href="../../src/maplibre/environment.rs.html#25">source</a><h4 class="code-header">type <a href="#associatedtype.HttpClient" class="associatedtype">HttpClient</a>: <a class="trait" href="../io/source_client/trait.HttpClient.html" title="trait maplibre::io::source_client::HttpClient">HttpClient</a></h4></section><section id="associatedtype.OffscreenKernelEnvironment" class="method"><a class="src rightside" href="../../src/maplibre/environment.rs.html#27">source</a><h4 class="code-header">type <a href="#associatedtype.OffscreenKernelEnvironment" class="associatedtype">OffscreenKernelEnvironment</a>: <a class="trait" href="trait.OffscreenKernelEnvironment.html" title="trait maplibre::environment::OffscreenKernelEnvironment">OffscreenKernelEnvironment</a></h4></section></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../implementors/maplibre/environment/trait.Environment.js" async></script></section></div></main></body></html> |