ZennDev1337/Rust-for-Arduboy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Rust-for-Arduboy/docs/doc/arduboy_rust/struct.EEPROM.html

25 lines
16 KiB
HTML
Raw Normal View History

update Docs
2023-08-15 13:31:46 +02:00
<!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="This struct to store and read structs objects to/from eeprom memory."><title>EEPROM in arduboy_rust - 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="arduboy_rust" data-themes="" data-resource-suffix="" data-rustdoc-version="1.73.0-nightly (8131b9774 2023-08-02)" data-channel="nightly" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-6d2c9675f3d09c26.css" data-theme-dark-css="dark-45ceb8f2e522f4d1.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-6d2c9675f3d09c26.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../static.files/dark-45ceb8f2e522f4d1.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 struct"><!--[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">&#9776;</button><a class="logo-container" href="../arduboy_rust/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="../arduboy_rust/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">EEPROM</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.get">get</a></li><li><a href="#method.get_direct">get_direct</a></li><li><a href="#method.init">init</a></li><li><a href="#method.new">new</a></li><li><a href="#method.put">put</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-EEPROM">RefUnwindSafe</a></li><li><a href="#impl-Send-for-EEPROM">Send</a></li><li><a href="#impl-Sync-for-EEPROM">Sync</a></li><li><a href="#impl-Unpin-for-EEPROM">Unpin</a></li><li><a href="#impl-UnwindSafe-for-EEPROM">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-EEPROM">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-EEPROM">Borrow&lt;
reordering the crate and addind more documentation and added the docs to the same repo
2023-08-15 12:41:08 +02:00
<h3 id="example"><a href="#example">Example</a></h3>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">static </span>e: EEPROM = EEPROM::new(<span class="number">10</span>);
<span class="kw">struct </span>Scorebord {
player1: u16,
text: <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>str,
}
<span class="kw">static </span><span class="kw-2">mut </span>s: Scorebord = Scorebord {
player1: <span class="number">0</span>,
text: <span class="string">&quot;lol\0&quot;</span>,
};
<span class="comment">// init inside of the setup function
</span>e.init(<span class="kw-2">&amp;mut </span>s);</code></pre></div>
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-EEPROM" class="impl"><a class="src rightside" href="../src/arduboy_rust/library/eeprom.rs.html#38-97">source</a><a href="#impl-EEPROM" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="prelude/struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></h3></section></summary><div class="impl-items"><section id="method.new" class="method"><a class="src rightside" href="../src/arduboy_rust/library/eeprom.rs.html#39-48">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>(idx: i16) -&gt; <a class="struct" href="prelude/struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></h4></section><section id="method.init" class="method"><a class="src rightside" href="../src/arduboy_rust/library/eeprom.rs.html#49-59">source</a><h4 class="code-header">pub fn <a href="#method.init" class="fn">init</a>&lt;T&gt;(&amp;self, your_struct: &amp;mut T)</h4></section><section id="method.get" class="method"><a class="src rightside" href="../src/arduboy_rust/library/eeprom.rs.html#66-74">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>&lt;T&gt;(&amp;self, your_struct: &amp;mut T)</h4></section><section id="method.get_direct" class="method"><a class="src rightside" href="../src/arduboy_rust/library/eeprom.rs.html#75-87">source</a><h4 class="code-header">pub fn <a href="#method.get_direct" class="fn">get_direct</a>&lt;T&gt;(&amp;self) -&gt; T</h4></section><section id="method.put" class="method"><a class="src rightside" href="../src/arduboy_rust/library/eeprom.rs.html#88-96">source</a><h4 class="code-header">pub fn <a href="#method.put" class="fn">put</a>&lt;T&gt;(&amp;self, your_struct: &amp;T)</h4></section></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-EEPROM" class="impl"><a href="#impl-RefUnwindSafe-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="prelude/struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></h3></section><section id="impl-Send-for-EEPROM" class="impl"><a href="#impl-Send-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl Send for <a class="struct" href="prelude/struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></h3></section><section id="impl-Sync-for-EEPROM" class="impl"><a href="#impl-Sync-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl Sync for <a class="struct" href="prelude/struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></h3></section><section id="impl-Unpin-for-EEPROM" class="impl"><a href="#impl-Unpin-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl Unpin for <a class="struct" href="prelude/struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></h3></section><section id="impl-UnwindSafe-for-EEPROM" class="impl"><a href="#impl-UnwindSafe-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="prelude/struct.EEPROM.html" title="struct arduboy_rust::prelude::EEPROM">EEPROM</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-EEPROM" class="impl"><a href="#impl-Any-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; Any for T<span class="where fmt-newline">where
T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a class="fn">type_id</a>(&amp;self) -&gt; TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-EEPROM" class="impl"><a href="#impl-Borrow%3CT%3E-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; Borrow&lt;T&gt; for T<span class="where fmt-newline">where
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow</a>(&amp;self) -&gt; &amp;T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-EEPROM" class="impl"><a href="#impl-BorrowMut%3CT%3E-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; BorrowMut&lt;T&gt; for T<span class="where fmt-newline">where
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow_mut</a>(&amp;mut self) -&gt; &amp;mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-EEPROM" class="impl"><a href="#impl-From%3CT%3E-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; From&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-EEPROM" class="impl"><a href="#impl-Into%3CU%3E-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; Into&lt;U&gt; for T<span class="where fmt-newline">where
U: From&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code>[From]&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-EEPROM" class="impl"><a href="#impl-TryFrom%3CU%3E-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; TryFrom&lt;U&gt; for T<span class="where fmt-newline">where
U: Into&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_from</a>(value: U) -&gt; Result&lt;T, &lt;T as TryFrom&lt;U&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-EEPROM" class="impl"><a href="#impl-TryInto%3CU%3E-for-EEPROM" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; TryInto&lt;U&gt; for T<span class="where fmt-newline">where
U: TryFrom&lt;T&gt;,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = &lt;U as TryFrom&lt;T&gt;&gt;::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_into</a>(self) -&gt; Result&lt;U, &lt;U as TryFrom&lt;T&gt;&gt;::Error&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
Reference in a new issue Copy permalink