ZennDev1337/Rust-for-Arduboy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

all FX functions are now safe wrapped and I added the crate to the docs also it is added to the prelude

Browse source
This commit is contained in:
ZennDev1337 2023-10-04 14:55:54 +02:00
parent 522844499e
commit b9e517fa21
1649 changed files with 72257 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

41
docs/doc/byteorder/index.html Normal file
View file

@ -0,0 +1,41 @@
<!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 crate provides convenience methods for encoding and decoding numbers in either big-endian or little-endian order."><title>byteorder - 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="byteorder" 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="../crates.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 mod crate"><!--[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="../byteorder/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="../byteorder/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Crate byteorder</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 1.4.3</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></section></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>Crate <a class="mod" href="#">byteorder</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/byteorder/lib.rs.html#1-4052">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate provides convenience methods for encoding and decoding numbers in
either <a href="https://en.wikipedia.org/wiki/Endianness">big-endian or little-endian order</a>.</p>
<p>The organization of the crate is pretty simple. A trait, <a href="trait.ByteOrder.html"><code>ByteOrder</code></a>, specifies
byte conversion methods for each type of number in Rust (sans numbers that have
a platform dependent size like <code>usize</code> and <code>isize</code>). Two types, <a href="enum.BigEndian.html"><code>BigEndian</code></a>
and <a href="enum.LittleEndian.html"><code>LittleEndian</code></a> implement these methods. Finally, <a href="trait.ReadBytesExt.html"><code>ReadBytesExt</code></a> and
<a href="trait.WriteBytesExt.html"><code>WriteBytesExt</code></a> provide convenience methods available to all types that
implement <a href="https://doc.rust-lang.org/std/io/trait.Read.html"><code>Read</code></a> and <a href="https://doc.rust-lang.org/std/io/trait.Write.html"><code>Write</code></a>.</p>
<p>An alias, <a href="type.NetworkEndian.html"><code>NetworkEndian</code></a>, for <a href="enum.BigEndian.html"><code>BigEndian</code></a> is provided to help improve
code clarity.</p>
<p>An additional alias, <a href="type.NativeEndian.html"><code>NativeEndian</code></a>, is provided for the endianness of the
local platform. This is convenient when serializing data for use and
conversions are not desired.</p>
<h2 id="examples"><a href="#examples">Examples</a></h2>
<p>Read unsigned 16 bit big-endian integers from a <a href="https://doc.rust-lang.org/std/io/trait.Read.html"><code>Read</code></a> type:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io::Cursor;
<span class="kw">use </span>byteorder::{BigEndian, ReadBytesExt};
<span class="kw">let </span><span class="kw-2">mut </span>rdr = Cursor::new(<span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">5</span>, <span class="number">3</span>, <span class="number">0</span>]);
<span class="comment">// Note that we use type parameters to indicate which kind of byte order
// we want!
</span><span class="macro">assert_eq!</span>(<span class="number">517</span>, rdr.read_u16::&lt;BigEndian&gt;().unwrap());
<span class="macro">assert_eq!</span>(<span class="number">768</span>, rdr.read_u16::&lt;BigEndian&gt;().unwrap());</code></pre></div>
<p>Write unsigned 16 bit little-endian integers to a <a href="https://doc.rust-lang.org/std/io/trait.Write.html"><code>Write</code></a> type:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{LittleEndian, WriteBytesExt};
<span class="kw">let </span><span class="kw-2">mut </span>wtr = <span class="macro">vec!</span>[];
wtr.write_u16::&lt;LittleEndian&gt;(<span class="number">517</span>).unwrap();
wtr.write_u16::&lt;LittleEndian&gt;(<span class="number">768</span>).unwrap();
<span class="macro">assert_eq!</span>(wtr, <span class="macro">vec!</span>[<span class="number">5</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">3</span>]);</code></pre></div>
<h2 id="optional-features"><a href="#optional-features">Optional Features</a></h2>
<p>This crate optionally provides support for 128 bit values (<code>i128</code> and <code>u128</code>)
when built with the <code>i128</code> feature enabled.</p>
<p>This crate can also be used without the standard library.</p>
<h2 id="alternatives"><a href="#alternatives">Alternatives</a></h2>
<p>Note that as of Rust 1.32, the standard numeric types provide built-in methods
like <code>to_le_bytes</code> and <code>from_le_bytes</code>, which support some of the same use
cases.</p>
</div></details><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.BigEndian.html" title="enum byteorder::BigEndian">BigEndian</a></div><div class="desc docblock-short">Defines big-endian serialization.</div></li><li><div class="item-name"><a class="enum" href="enum.LittleEndian.html" title="enum byteorder::LittleEndian">LittleEndian</a></div><div class="desc docblock-short">Defines little-endian serialization.</div></li></ul><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ByteOrder.html" title="trait byteorder::ByteOrder">ByteOrder</a></div><div class="desc docblock-short"><code>ByteOrder</code> describes types that can serialize integers as bytes.</div></li></ul><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BE.html" title="type byteorder::BE">BE</a></div><div class="desc docblock-short">A type alias for <a href="enum.BigEndian.html"><code>BigEndian</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.LE.html" title="type byteorder::LE">LE</a></div><div class="desc docblock-short">A type alias for <a href="enum.LittleEndian.html"><code>LittleEndian</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.NativeEndian.html" title="type byteorder::NativeEndian">NativeEndian</a></div><div class="desc docblock-short">Defines system native-endian serialization.</div></li><li><div class="item-name"><a class="type" href="type.NetworkEndian.html" title="type byteorder::NetworkEndian">NetworkEndian</a></div><div class="desc docblock-short">Defines network byte order serialization.</div></li></ul></section></div></main></body></html>