mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-11-26 05:29:38 +01:00
41 lines
8.6 KiB
HTML
41 lines
8.6 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="This crate provides convenience methods for encoding and decoding numbers in either big-endian or little-endian order."><title>byteorder - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-492a78a4a87dcc01.css"><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.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-3b12f09e550e0385.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../byteorder/index.html">byteorder</a><span class="version">1.5.0</span></h2></div><div class="sidebar-elems"><ul class="block"><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 Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><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">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/byteorder/lib.rs.html#1-3975">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</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 class="doc-anchor" href="#examples">§</a>Examples</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::<BigEndian>().unwrap());
|
||
|
|
<span class="macro">assert_eq!</span>(<span class="number">768</span>, rdr.read_u16::<BigEndian>().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::<LittleEndian>(<span class="number">517</span>).unwrap();
|
||
|
|
wtr.write_u16::<LittleEndian>(<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 class="doc-anchor" href="#optional-features">§</a>Optional Features</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 class="doc-anchor" href="#alternatives">§</a>Alternatives</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="section-header">Enums<a href="#enums" class="anchor">§</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">Little<wbr>Endian</a></div><div class="desc docblock-short">Defines little-endian serialization.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ByteOrder.html" title="trait byteorder::ByteOrder">Byte<wbr>Order</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="section-header">Type Aliases<a href="#types" class="anchor">§</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">Native<wbr>Endian</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">Network<wbr>Endian</a></div><div class="desc docblock-short">Defines network byte order serialization.</div></li></ul></section></div></main></body></html>
|