Skip to content

Commit 509681b

Browse files
rex-schilaskyrex-schilasky
committed
deploy: 2b21556 
1 parent 3a802b1 commit 509681b

File tree

10 files changed

+945
-9
lines changed

10 files changed

+945
-9
lines changed

‎api/ecal.html‎

Lines changed: 220 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,220 @@
1+
<!DOCTYPE HTML>
2+
<html lang="en" class="light sidebar-visible" dir="ltr">
3+
<head>
4+
<!-- Book generated using mdBook -->
5+
<meta charset="UTF-8">
6+
<title>Ecal Lifecycle - rustecal Documentation</title>
7+
8+
9+
<!-- Custom HTML head -->
10+
11+
<meta name="description" content="">
12+
<meta name="viewport" content="width=device-width, initial-scale=1">
13+
<meta name="theme-color" content="#ffffff">
14+
15+
<link rel="icon" href="../favicon.svg">
16+
<link rel="shortcut icon" href="../favicon.png">
17+
<link rel="stylesheet" href="../css/variables.css">
18+
<link rel="stylesheet" href="../css/general.css">
19+
<link rel="stylesheet" href="../css/chrome.css">
20+
<link rel="stylesheet" href="../css/print.css" media="print">
21+
22+
<!-- Fonts -->
23+
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
24+
<link rel="stylesheet" href="../fonts/fonts.css">
25+
26+
<!-- Highlight.js Stylesheets -->
27+
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
28+
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
29+
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
30+
31+
<!-- Custom theme stylesheets -->
32+
33+
34+
<!-- Provide site root and default themes to javascript -->
35+
<script>
36+
const path_to_root = "../";
37+
const default_light_theme = "light";
38+
const default_dark_theme = "navy";
39+
</script>
40+
<!-- Start loading toc.js asap -->
41+
<script src="../toc.js"></script>
42+
</head>
43+
<body>
44+
<div id="body-container">
45+
<!-- Work around some values being stored in localStorage wrapped in quotes -->
46+
<script>
47+
try {
48+
let theme = localStorage.getItem('mdbook-theme');
49+
let sidebar = localStorage.getItem('mdbook-sidebar');
50+
51+
if (theme.startsWith('"') && theme.endsWith('"')) {
52+
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
53+
}
54+
55+
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
56+
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
57+
}
58+
} catch (e) { }
59+
</script>
60+
61+
<!-- Set the theme before any content is loaded, prevents flash -->
62+
<script>
63+
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
64+
let theme;
65+
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
66+
if (theme === null || theme === undefined) { theme = default_theme; }
67+
const html = document.documentElement;
68+
html.classList.remove('light')
69+
html.classList.add(theme);
70+
html.classList.add("js");
71+
</script>
72+
73+
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
74+
75+
<!-- Hide / unhide sidebar before it is displayed -->
76+
<script>
77+
let sidebar = null;
78+
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
79+
if (document.body.clientWidth >= 1080) {
80+
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
81+
sidebar = sidebar || 'visible';
82+
} else {
83+
sidebar = 'hidden';
84+
}
85+
sidebar_toggle.checked = sidebar === 'visible';
86+
html.classList.remove('sidebar-visible');
87+
html.classList.add("sidebar-" + sidebar);
88+
</script>
89+
90+
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
91+
<!-- populated by js -->
92+
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
93+
<noscript>
94+
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
95+
</noscript>
96+
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
97+
<div class="sidebar-resize-indicator"></div>
98+
</div>
99+
</nav>
100+
101+
<div id="page-wrapper" class="page-wrapper">
102+
103+
<div class="page">
104+
<div id="menu-bar-hover-placeholder"></div>
105+
<div id="menu-bar" class="menu-bar sticky">
106+
<div class="left-buttons">
107+
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
108+
<i class="fa fa-bars"></i>
109+
</label>
110+
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
111+
<i class="fa fa-paint-brush"></i>
112+
</button>
113+
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
114+
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
115+
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
116+
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
117+
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
118+
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
119+
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
120+
</ul>
121+
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
122+
<i class="fa fa-search"></i>
123+
</button>
124+
</div>
125+
126+
<h1 class="menu-title">rustecal Documentation</h1>
127+
128+
<div class="right-buttons">
129+
<a href="../print.html" title="Print this book" aria-label="Print this book">
130+
<i id="print-button" class="fa fa-print"></i>
131+
</a>
132+
133+
</div>
134+
</div>
135+
136+
<div id="search-wrapper" class="hidden">
137+
<form id="searchbar-outer" class="searchbar-outer">
138+
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
139+
</form>
140+
<div id="searchresults-outer" class="searchresults-outer hidden">
141+
<div id="searchresults-header" class="searchresults-header"></div>
142+
<ul id="searchresults">
143+
</ul>
144+
</div>
145+
</div>
146+
147+
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
148+
<script>
149+
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
150+
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
151+
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
152+
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
153+
});
154+
</script>
155+
156+
<div id="content" class="content">
157+
<main>
158+
<h1 id="ecal-lifecycle"><a class="header" href="#ecal-lifecycle">Ecal Lifecycle</a></h1>
159+
<p>The <code>Ecal</code> struct manages initialization and finalization of the eCAL system.</p>
160+
<h2 id="example"><a class="header" href="#example">Example</a></h2>
161+
<pre><pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
162+
</span><span class="boring">fn main() {
163+
</span>use rustecal::Ecal;
164+
165+
let ecal = Ecal::initialize("my_rust_app")?;
166+
// use publishers or subscribers
167+
drop(ecal); // finalizes on drop
168+
<span class="boring">}</span></code></pre></pre>
169+
170+
</main>
171+
172+
<nav class="nav-wrapper" aria-label="Page navigation">
173+
<!-- Mobile navigation buttons -->
174+
<a rel="prev" href="../api/index.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
175+
<i class="fa fa-angle-left"></i>
176+
</a>
177+
178+
<a rel="next prefetch" href="../api/publisher.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
179+
<i class="fa fa-angle-right"></i>
180+
</a>
181+
182+
<div style="clear: both"></div>
183+
</nav>
184+
</div>
185+
</div>
186+
187+
<nav class="nav-wide-wrapper" aria-label="Page navigation">
188+
<a rel="prev" href="../api/index.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
189+
<i class="fa fa-angle-left"></i>
190+
</a>
191+
192+
<a rel="next prefetch" href="../api/publisher.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
193+
<i class="fa fa-angle-right"></i>
194+
</a>
195+
</nav>
196+
197+
</div>
198+
199+
200+
201+
202+
<script>
203+
window.playground_copyable = true;
204+
</script>
205+
206+
207+
<script src="../elasticlunr.min.js"></script>
208+
<script src="../mark.min.js"></script>
209+
<script src="../searcher.js"></script>
210+
211+
<script src="../clipboard.min.js"></script>
212+
<script src="../highlight.js"></script>
213+
<script src="../book.js"></script>
214+
215+
<!-- Custom JS scripts -->
216+
217+
218+
</div>
219+
</body>
220+
</html>

‎api/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ <h1 id="api-documentation"><a class="header" href="#api-documentation">API Docum
159159
<p>Welcome to the <code>rustecal</code> API documentation. This section provides an overview of the main types and traits used to interact with the eCAL communication system through safe and idiomatic Rust APIs.</p>
160160
<h2 id="modules-overview"><a class="header" href="#modules-overview">Modules Overview</a></h2>
161161
<ul>
162-
<li><a href="../api/ecal.html"><code>Ecal</code></a> — Lifecycle manager for eCAL initialization and finalization.</li>
162+
<li><a href="./ecal.html"><code>Ecal</code></a> — Lifecycle manager for eCAL initialization and finalization.</li>
163163
<li><a href="./publisher.html"><code>Publisher&lt;T&gt;</code></a> — Generic typed publisher used to send messages on a topic.</li>
164164
<li><a href="./subscriber.html"><code>Subscriber&lt;T&gt;</code></a> — Generic typed subscriber used to receive messages.</li>
165165
<li><a href="./message_types.html"><code>MessageType</code></a> — Trait for enabling custom serialization of types.</li>
@@ -196,7 +196,7 @@ <h2 id="usage-highlights"><a class="header" href="#usage-highlights">Usage Highl
196196
<i class="fa fa-angle-left"></i>
197197
</a>
198198

199-
<a rel="next prefetch" href="../project_status.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
199+
<a rel="next prefetch" href="../api/ecal.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
200200
<i class="fa fa-angle-right"></i>
201201
</a>
202202

@@ -210,7 +210,7 @@ <h2 id="usage-highlights"><a class="header" href="#usage-highlights">Usage Highl
210210
<i class="fa fa-angle-left"></i>
211211
</a>
212212

213-
<a rel="next prefetch" href="../project_status.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
213+
<a rel="next prefetch" href="../api/ecal.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
214214
<i class="fa fa-angle-right"></i>
215215
</a>
216216
</nav>

0 commit comments

Comments
 (0)