<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="This is the important one to use this library effective in your project"><title>arduboy_rust::prelude - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-47e7ab555ef2818a.css"><metaname="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.74.0-nightly (d9c8274fb 2023-09-12)"data-channel="nightly"data-search-js="search-5d3eaacf19ebf04f.js"data-settings-js="settings-74424d7eec62a23e.js"data-settings-css="settings-8c76f75bfb6bd192.css"data-theme-light-css="light-f194925aa375ae96.css"data-theme-dark-css="dark-1dd4d1ce031e15de.css"data-theme-ayu-css="ayu-49e58d069f567085.css"><scriptsrc="../../static.files/storage-db41da1a38ea3cb8.js"></script><scriptdefersrc="../../static.files/main-8d035c8cea6edbc4.js"></script><noscript><linkrel="stylesheet"media="(prefers-color-scheme:light)"href="../../static.files/light-f194925aa375ae96.css"><linkrel="stylesheet"media="(prefers-color-scheme:dark)"href="../../static.files/dark-1dd4d1ce031e15de.css"><linkrel="stylesheet"href="../../static.files/noscript-cffde32267a19fd6.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="logo-container"href="../../arduboy_rust/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2></h2></nav><navclass="sidebar"><aclass="logo-container"href="../../arduboy_rust/index.html"><imgclass="rust-logo"src="../../static.files/rust-logo-151179464ae7ed46.svg"alt="logo"></a><h2class="location"><ahref="#">Module prelude</a></h2><divclass="sidebar-elems"><section><ulclass="block"><li><ahref="#reexports">Re-exports</a></li><li><ahref="#modules">Modules</a></li><li><ahref="#macros">Macros</a></li><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li><li><ahref="#constants">Constants</a></li><li><ahref="#traits">Traits</a></li><li><ahref="#functions">Functions</a></li><li><ahref="#types">Type Aliases</a></li></ul></section></div></nav><main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><inputclass="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"><divid="help-button"title="help"tabindex="-1"><ahref="../../help.html">?</a></div><divid="settings-menu"tabindex="-1"><ah
</div></details><h2id="reexports"class="small-section-header"><ahref="#reexports">Re-exports</a></h2><ulclass="item-table"><li><divclass="item-name"id="reexport.serial"><code>pub use crate::<aclass="mod"href="../serial_print/index.html"title="mod arduboy_rust::serial_print">serial_print</a> as serial;</code></div></li></ul><h2id="modules"class="small-section-header"><ahref="#modules">Modules</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="mod"href="arduboy2/index.html"title="mod arduboy_rust::prelude::arduboy2">arduboy2</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the Arduboy2 C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="arduboy_tone/index.html"title="mod arduboy_rust::prelude::arduboy_tone">arduboy_tone</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the ArduboyTones C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="ardvoice/index.html"title="mod arduboy_rust::prelude::ardvoice">ardvoice</a></div><divclass="desc docblock-short">This is the Module to interact in a save way with the ArdVoice C++ library.</div></li><li><divclass="item-name"><aclass="mod"href="buttons/index.html"title="mod arduboy_rust::prelude::buttons">buttons</a></div><divclass="desc docblock-short">A list of all six buttons available on the Arduboy</div></li><li><divclass="item-name"><aclass="mod"href="led/index.html"title="mod arduboy_rust::prelude::led">led</a></div><divclass="desc docblock-short">A list of all LED variables available</div></li><li><divclass="item-name"><aclass="mod"href="sprites/index.html"title="mod arduboy_rust::prelude::sprites">sprites</a></div><divclass="desc docblock-short">This is the module to interact in a save way with the Sprites C++ library.</div></li></ul><h2id="macros"class="small-section-header"><ahref="#macros">Macros</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="macro"href="macro.f.html"title="macro arduboy_rust::prelude::f">f</a></div><divclass="desc docblock-short">This is the way to go if you want print some random text</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_ardvoice_tone_addr.html"title="macro arduboy_rust::prelude::get_ardvoice_tone_addr">get_ardvoice_tone_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a ardvoice tone as u8, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_sprite_addr.html"title="macro arduboy_rust::prelude::get_sprite_addr">get_sprite_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a sprite as u8, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_string_addr.html"title="macro arduboy_rust::prelude::get_string_addr">get_string_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a [u8;_] that saves text, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.get_tones_addr.html"title="macro arduboy_rust::prelude::get_tones_addr">get_tones_addr</a></div><divclass="desc docblock-short">Create a <code>const</code> raw pointer to a tone sequenze as u16, without creating an intermediate reference.</div></li><li><divclass="item-name"><aclass="macro"href="macro.progmem.html"title="macro arduboy_rust::prelude::progmem">progmem</a></div><divclass="desc docblock-short">Create a space for Progmem variable</div></li></ul><h2id="structs"class="small-section-header"><ahref="#structs">Structs</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.ArdVoice.html"title="struct arduboy_rust::prelude::ArdVoice">ArdVoice</a></div><divclass="desc docblock-short">This is the struct to interact in a save way with the ArdVoice C++ library.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Arduboy2.html"title
Unlike the other eeprom structs, this does not need to be initialised.</div></li><li><divclass="item-name"><aclass="struct"href="struct.LinearMap.html"title="struct arduboy_rust::prelude::LinearMap">LinearMap</a></div><divclass="desc docblock-short">A fixed capacity map / dictionary that performs lookups via linear search</div></li><li><divclass="item-name"><aclass="struct"href="struct.Point.html"title="struct arduboy_rust::prelude::Point">Point</a></div><divclass="desc docblock-short">This struct is used by a few Arduboy functions.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Rect.html"title="struct arduboy_rust::prelude::Rect">Rect</a></div><divclass="desc docblock-short">This struct is used by a few Arduboy functions.</div></li><li><divclass="item-name"><aclass="struct"href="struct.String.html"title="struct arduboy_rust::prelude::String">String</a></div><divclass="desc docblock-short">A fixed capacity <ahref="https://doc.rust-lang.org/std/string/struct.String.html"><code>String</code></a></div></li><li><divclass="item-name"><aclass="struct"href="struct.Vec.html"title="struct arduboy_rust::prelude::Vec">Vec</a></div><divclass="desc docblock-short">A fixed capacity <ahref="https://doc.rust-lang.org/std/vec/struct.Vec.html"><code>Vec</code></a></div></li></ul><h2id="enums"class="small-section-header"><ahref="#enums">Enums</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.Base.html"title="enum arduboy_rust::prelude::Base">Base</a></div></li><li><divclass="item-name"><aclass="enum"href="enum.Color.html"title="enum arduboy_rust::prelude::Color">Color</a></div><divclass="desc docblock-short">This item is to chose between Black or White</div></li></ul><h2id="constants"class="small-section-header"><ahref="#constants">Constants</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="constant"href="constant.A.html"title="constant arduboy_rust::prelude::A">A</a></div><divclass="desc docblock-short">Just a <code>const</code> for the A button</div></li><li><divclass="item-name"><aclass="constant"href="constant.A_BUTTON.html"title="constant arduboy_rust::prelude::A_BUTTON">A_BUTTON</a></div><divclass="desc docblock-short">Just a <code>const</code> for the A button</div></li><li><divclass="item-name"><aclass="constant"href="constant.B.html"title="constant arduboy_rust::prelude::B">B</a></div><divclass="desc docblock-short">Just a <code>const</code> for the B button</div></li><li><divclass="item-name"><aclass="constant"href="constant.BLUE_LED.html"title="constant arduboy_rust::prelude::BLUE_LED">BLUE_LED</a></div><divclass="desc docblock-short">Just a <code>const</code> for the blue led</div></li><li><divclass="item-name"><aclass="constant"href="constant.B_BUTTON.html"title="constant arduboy_rust::prelude::B_BUTTON">B_BUTTON</a></div><divclass="desc docblock-short">Just a <code>const</code> for the B button</div></li><li><divclass="item-name"><aclass="constant"href="constant.DOWN.html"title="constant arduboy_rust::prelude::DOWN">DOWN</a></div><divclass="desc docblock-short">Just a <code>const</code> for the DOWN button</div></li><li><divclass="item-name"><aclass="constant"href="constant.DOWN_BUTTON.html"title="constant arduboy_rust::prelude::DOWN_BUTTON">DOWN_BUTTON</a></div><divclass="desc docblock-short">Just a <code>const</code> for the DOWN button</div></li><li><divclass="item-name"><aclass="constant"href="constant.FONT_SIZE.html"title="constant arduboy_rust::prelude::FONT_SIZE">FONT_SIZE</a></div><divclass="desc docblock-short">The standard font size of the arduboy</div></li><li><divclass="item-name"><aclass="constant"href="constant.GREEN_LED.html"title="constant arduboy_rust::prelude::GREEN_LED">GREEN_LED</a></div><divclass="desc docblock-short">Just a <code>const</code> for the green led</div></li><li><divclass="item-name"><aclass="constant"href="constant.HEIGHT.html"title="constant arduboy_rust::prelude::HEIGHT">HEIGHT</a></div><divclass="desc docblock-short">The standard he
seed based</div></li><li><divclass="item-name"><aclass="fn"href="fn.random_less_than.html"title="fn arduboy_rust::prelude::random_less_than">random_less_than</a></div><divclass="desc docblock-short">A Arduino function to get a random number smaller than the number given
seed based</div></li><li><divclass="item-name"><aclass="fn"href="fn.strlen.html"title="fn arduboy_rust::prelude::strlen">strlen</a></div><divclass="desc docblock-short">A C function to get the length of a string</div></li></ul><h2id="types"class="small-section-header"><ahref="#types">Type Aliases</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="type"href="type.c_size_t.html"title="type arduboy_rust::prelude::c_size_t">c_size_t</a><spanclass="stab unstable"title="">Experimental</span></div><divclass="desc docblock-short">Equivalent to C’s <code>size_t</code> type, from <code>stddef.h</code> (or <code>cstddef</code> for C++).</div></li><li><divclass="item-name"><aclass="type"href="type.c_char.html"title="type arduboy_rust::prelude::c_char">c_char</a></div><divclass="desc docblock-short">Equivalent to C’s <code>char</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_double.html"title="type arduboy_rust::prelude::c_double">c_double</a></div><divclass="desc docblock-short">Equivalent to C’s <code>double</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_float.html"title="type arduboy_rust::prelude::c_float">c_float</a></div><divclass="desc docblock-short">Equivalent to C’s <code>float</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_int.html"title="type arduboy_rust::prelude::c_int">c_int</a></div><divclass="desc docblock-short">Equivalent to C’s <code>signed int</code> (<code>int</code>) type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_long.html"title="type arduboy_rust::prelude::c_long">c_long</a></div><divclass="desc docblock-short">Equivalent to C’s <code>signed long</code> (<code>long</code>) type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_longlong.html"title="type arduboy_rust::prelude::c_longlong">c_longlong</a></div><divclass="desc docblock-short">Equivalent to C’s <code>signed long long</code> (<code>long long</code>) type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_uchar.html"title="type arduboy_rust::prelude::c_uchar">c_uchar</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned char</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_uint.html"title="type arduboy_rust::prelude::c_uint">c_uint</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned int</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_ulong.html"title="type arduboy_rust::prelude::c_ulong">c_ulong</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned long</code> type.</div></li><li><divclass="item-name"><aclass="type"href="type.c_ulonglong.html"title="type arduboy_rust::prelude::c_ulonglong">c_ulonglong</a></div><divclass="desc docblock-short">Equivalent to C’s <code>unsigned long long</code> type.</div></li></ul></section></div></main></body></html>
