<!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 `cpu_endian` crate."><meta name="keywords" content="rust, rustlang, rust-lang, cpu_endian"><title>cpu_endian - 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="../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../ayu.css" disabled ><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../favicon.svg">
<link rel="alternate icon" type="image/png" href="../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><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='../cpu_endian/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate cpu_endian</p><div class='block version'><p>Version 0.1.1</p></div><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all cpu_endian's items</p></a><div class="block items"><ul><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'cpu_endian', 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"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><span class="help-button">?</span>
<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/cpu_endian/lib.rs.html#70-192' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>cpu_endian</a></span></h1><div class='docblock'><h1 id="cpu-endian" class="section-header"><a href="#cpu-endian">cpu-endian</a></h1>
<p><code>cpu-endian</code> is a portable crate to detect CPU byte order.</p>
<p>It detects how CPU native scalar type is ordered; little-endian or big-endian, or something else (like PDP-endian, mixed-endian, middle-endian, and so on.)</p>
<h2 id="examples" class="section-header"><a href="#examples">Examples</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered">
<span class="kw">use</span> <span class="ident">cpu_endian</span>::{<span class="ident">Endian</span>, <span class="ident">working</span>};
<span class="comment">// Takes first octet of 0x00ff: u16.</span>
<span class="kw">let</span> <span class="ident">v</span>: <span class="ident">u16</span> <span class="op">=</span> <span class="number">0x00ff</span>;
<span class="kw">let</span> <span class="ident">first_octet</span>: <span class="ident">u8</span> <span class="op">=</span> <span class="kw">unsafe</span> {
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="kw-2">&</span><span class="ident">v</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">u16</span>;
<span class="kw">let</span> <span class="ident">ptr</span> <span class="op">=</span> <span class="ident">ptr</span> <span class="kw">as</span> <span class="kw-2">*</span><span class="kw">const</span> <span class="ident">u8</span>;
<span class="kw-2">*</span><span class="ident">ptr</span>
};
<span class="comment">// If the byte-order is little-endian, the first octet should be 0xff, or if big-endian,</span>
<span class="comment">// it should be 0x00.</span>
<span class="kw">match</span> <span class="ident">working</span>() {
<span class="ident">Endian</span>::<span class="ident">Little</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0xff</span>, <span class="ident">first_octet</span>),
<span class="ident">Endian</span>::<span class="ident">Big</span> <span class="op">=</span><span class="op">></span> <span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">0x00</span>, <span class="ident">first_octet</span>),
<span class="kw">_</span> <span class="op">=</span><span class="op">></span> {},
}</pre></div>
</div><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.Endian.html" title='cpu_endian::Endian enum'>Endian</a></td><td class='docblock-short'><p>Byte order of scalar types.</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.working.html" title='cpu_endian::working fn'>working</a></td><td class='docblock-short'><p>Returns the CPU byte order.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../";window.currentCrate = "cpu_endian";</script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>