|
|
<!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="API documentation for the Rust `byteorder` crate."><meta name="keywords" content="rust, rustlang, rust-lang, byteorder"><title>byteorder - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../byteorder/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate byteorder</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all byteorder's items</p></a><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'byteorder', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/byteorder/lib.rs.html#1-3328' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>byteorder</a></span></h1><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>
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
<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">
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">io</span>::<span class="ident">Cursor</span>;
|
|
|
<span class="kw">use</span> <span class="ident">byteorder</span>::{<span class="ident">BigEndian</span>, <span class="ident">ReadBytesExt</span>};
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rdr</span> <span class="op">=</span> <span class="ident">Cursor</span>::<span class="ident">new</span>(<span class="macro">vec</span><span class="macro">!</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</span>
|
|
|
<span class="comment">// we want!</span>
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">517</span>, <span class="ident">rdr</span>.<span class="ident">read_u16</span>::<span class="op"><</span><span class="ident">BigEndian</span><span class="op">></span>().<span class="ident">unwrap</span>());
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">768</span>, <span class="ident">rdr</span>.<span class="ident">read_u16</span>::<span class="op"><</span><span class="ident">BigEndian</span><span class="op">></span>().<span class="ident">unwrap</span>());</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">
|
|
|
<span class="kw">use</span> <span class="ident">byteorder</span>::{<span class="ident">LittleEndian</span>, <span class="ident">WriteBytesExt</span>};
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">wtr</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[];
|
|
|
<span class="ident">wtr</span>.<span class="ident">write_u16</span>::<span class="op"><</span><span class="ident">LittleEndian</span><span class="op">></span>(<span class="number">517</span>).<span class="ident">unwrap</span>();
|
|
|
<span class="ident">wtr</span>.<span class="ident">write_u16</span>::<span class="op"><</span><span class="ident">LittleEndian</span><span class="op">></span>(<span class="number">768</span>).<span class="ident">unwrap</span>();
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">wtr</span>, <span class="macro">vec</span><span class="macro">!</span>[<span class="number">5</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">3</span>]);</pre></div>
|
|
|
<h1 id="optional-features" class="section-header"><a href="#optional-features">Optional Features</a></h1>
|
|
|
<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>
|
|
|
<h1 id="alternatives" class="section-header"><a href="#alternatives">Alternatives</a></h1>
|
|
|
<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><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.BigEndian.html" title='byteorder::BigEndian enum'>BigEndian</a></td><td class='docblock-short'><p>Defines big-endian serialization.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="enum" href="enum.LittleEndian.html" title='byteorder::LittleEndian enum'>LittleEndian</a></td><td class='docblock-short'><p>Defines little-endian serialization.</p>
|
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.ByteOrder.html" title='byteorder::ByteOrder trait'>ByteOrder</a></td><td class='docblock-short'><p><code>ByteOrder</code> describes types that can serialize integers as bytes.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.ReadBytesExt.html" title='byteorder::ReadBytesExt trait'>ReadBytesExt</a></td><td class='docblock-short'><p>Extends <a href="https://doc.rust-lang.org/std/io/trait.Read.html"><code>Read</code></a> with methods for reading numbers. (For <code>std::io</code>.)</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.WriteBytesExt.html" title='byteorder::WriteBytesExt trait'>WriteBytesExt</a></td><td class='docblock-short'><p>Extends <a href="https://doc.rust-lang.org/std/io/trait.Write.html"><code>Write</code></a> with methods for writing numbers. (For <code>std::io</code>.)</p>
|
|
|
</td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="type" href="type.BE.html" title='byteorder::BE type'>BE</a></td><td class='docblock-short'><p>A type alias for <a href="enum.BigEndian.html"><code>BigEndian</code></a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="type" href="type.LE.html" title='byteorder::LE type'>LE</a></td><td class='docblock-short'><p>A type alias for <a href="enum.LittleEndian.html"><code>LittleEndian</code></a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="type" href="type.NativeEndian.html" title='byteorder::NativeEndian type'>NativeEndian</a></td><td class='docblock-short'><p>Defines system native-endian serialization.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="type" href="type.NetworkEndian.html" title='byteorder::NetworkEndian type'>NetworkEndian</a></td><td class='docblock-short'><p>Defines network byte order serialization.</p>
|
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "byteorder";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |
