diesel/master/byteorder/index.html at gh-pages · ITCSsDeveloper/diesel · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<!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."><meta name="keywords" content="rust, rustlang, rust-lang, byteorder"><title>byteorder - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><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="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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="sidebar-logo" href="../byteorder/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
        </a><h2 class="location"></h2>
    </nav>
    <nav class="sidebar"><a class="sidebar-logo" href="../byteorder/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
        </a><h2 class="location"><a href="#">Crate byteorder</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 1.4.3</li><li><a id="all-types" href="all.html">All Items</a></li></ul></div><section><div class="block"><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></section></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../byteorder/index.html"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></a><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><button type="button">?</button></div><div id="settings-menu" tabindex="-1">
                                <a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div>
                        </div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
    <h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">byteorder</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../src/byteorder/lib.rs.html#1-4052">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-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> <span class="ident">std::io::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::new</span>(<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</span>
<span class="comment">// we want!</span>
<span class="macro">assert_eq!</span>(<span class="number">517</span>, <span class="ident">rdr</span>.<span class="ident">read_u16</span>::<span class="op">&lt;</span><span class="ident">BigEndian</span><span class="op">&gt;</span>().<span class="ident">unwrap</span>());
<span class="macro">assert_eq!</span>(<span class="number">768</span>, <span class="ident">rdr</span>.<span class="ident">read_u16</span>::<span class="op">&lt;</span><span class="ident">BigEndian</span><span class="op">&gt;</span>().<span class="ident">unwrap</span>());</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> <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="ident">wtr</span>.<span class="ident">write_u16</span>::<span class="op">&lt;</span><span class="ident">LittleEndian</span><span class="op">&gt;</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">&lt;</span><span class="ident">LittleEndian</span><span class="op">&gt;</span>(<span class="number">768</span>).<span class="ident">unwrap</span>();
<span class="macro">assert_eq!</span>(<span class="ident">wtr</span>, <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>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.BigEndian.html" title="byteorder::BigEndian enum">BigEndian</a></div><div class="item-right docblock-short"><p>Defines big-endian serialization.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.LittleEndian.html" title="byteorder::LittleEndian enum">LittleEndian</a></div><div class="item-right docblock-short"><p>Defines little-endian serialization.</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ByteOrder.html" title="byteorder::ByteOrder trait">ByteOrder</a></div><div class="item-right docblock-short"><p><code>ByteOrder</code> describes types that can serialize integers as bytes.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.ReadBytesExt.html" title="byteorder::ReadBytesExt trait">ReadBytesExt</a></div><div class="item-right 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>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.WriteBytesExt.html" title="byteorder::WriteBytesExt trait">WriteBytesExt</a></div><div class="item-right 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>
</div></div></div><h2 id="types" class="small-section-header"><a href="#types">Type Definitions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="type" href="type.BE.html" title="byteorder::BE type">BE</a></div><div class="item-right docblock-short"><p>A type alias for <a href="enum.BigEndian.html"><code>BigEndian</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.LE.html" title="byteorder::LE type">LE</a></div><div class="item-right docblock-short"><p>A type alias for <a href="enum.LittleEndian.html"><code>LittleEndian</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.NativeEndian.html" title="byteorder::NativeEndian type">NativeEndian</a></div><div class="item-right docblock-short"><p>Defines system native-endian serialization.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="type" href="type.NetworkEndian.html" title="byteorder::NetworkEndian type">NetworkEndian</a></div><div class="item-right docblock-short"><p>Defines network byte order serialization.</p>
</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="byteorder" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0-nightly (495b21669 2022-07-03)" ></div>
</body></html>