| <!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="`ByteOrder` describes types that can serialize integers as bytes."><meta name="keywords" content="rust, rustlang, rust-lang, ByteOrder"><title>ByteOrder in 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" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.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 trait"><!--[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">☰</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></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="#">ByteOrder</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.from_slice_f32">from_slice_f32</a></li><li><a href="#tymethod.from_slice_f64">from_slice_f64</a></li><li><a href="#tymethod.from_slice_u128">from_slice_u128</a></li><li><a href="#tymethod.from_slice_u16">from_slice_u16</a></li><li><a href="#tymethod.from_slice_u32">from_slice_u32</a></li><li><a href="#tymethod.from_slice_u64">from_slice_u64</a></li><li><a href="#tymethod.read_u128">read_u128</a></li><li><a href="#tymethod.read_u128_into">read_u128_into</a></li><li><a href="#tymethod.read_u16">read_u16</a></li><li><a href="#tymethod.read_u16_into">read_u16_into</a></li><li><a href="#tymethod.read_u32">read_u32</a></li><li><a href="#tymethod.read_u32_into">read_u32_into</a></li><li><a href="#tymethod.read_u64">read_u64</a></li><li><a href="#tymethod.read_u64_into">read_u64_into</a></li><li><a href="#tymethod.read_uint">read_uint</a></li><li><a href="#tymethod.read_uint128">read_uint128</a></li><li><a href="#tymethod.write_u128">write_u128</a></li><li><a href="#tymethod.write_u128_into">write_u128_into</a></li><li><a href="#tymethod.write_u16">write_u16</a></li><li><a href="#tymethod.write_u16_into">write_u16_into</a></li><li><a href="#tymethod.write_u32">write_u32</a></li><li><a href="#tymethod.write_u32_into">write_u32_into</a></li><li><a href="#tymethod.write_u64">write_u64</a></li><li><a href="#tymethod.write_u64_into">write_u64_into</a></li><li><a href="#tymethod.write_uint">write_uint</a></li><li><a href="#tymethod.write_uint128">write_uint128</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.from_slice_i128">from_slice_i128</a></li><li><a href="#method.from_slice_i16">from_slice_i16</a></li><li><a href="#method.from_slice_i32">from_slice_i32</a></li><li><a href="#method.from_slice_i64">from_slice_i64</a></li><li><a href="#method.read_f32">read_f32</a></li><li><a href="#method.read_f32_into">read_f32_into</a></li><li><a href="#method.read_f32_into_unchecked">read_f32_into_unchecked</a></li><li><a href="#method.read_f64">read_f64</a></li><li><a href="#method.read_f64_into">read_f64_into</a></li><li><a href="#method.read_f64_into_unchecked">read_f64_into_unchecked</a></li><li><a href="#method.read_i128">read_i128</a></li><li><a href="#method.read_i128_into">read_i128_into</a></li><li><a href="#method.read_i16">read_i16</a></li><li><a href="#method.read_i16_into">read_i16_into</a></li><li><a href="#method.read_i24">read_i24</a></li><li><a href="#method.read_i32">read_i32</a></li><li><a href="#method.read_i32_into">read_i32_into</a></li><li><a href="#method.read_i48">read_i48</a></li><li><a href="#method.read_i64">read_i64</a></li><li><a href="#method.read_i64_into">read_i64_into</a></li><li><a href="#method.read_int">read_int</a></li><li><a href="#method.read_int128">read_int128</a></li><li><a href="#method.read_u24">read_u24</a></li><li><a href="#method.read_u48">read_u48</a></li><li><a href="#method.write_f32">write_f32</a></li><li><a href="#method.write_f32_into">write_f32_into</a></li><li><a href="#method.write_f64">write_f64</a></li><li><a href="#method.write_f64_into">write_f64_into</a></li><li><a href="#method.write_i128">write_i128</a></li><li><a href="#method.write_i128_into">write_i128_into</a></li><li><a href="#method.write_i16">write_i16</a></li><li><a href="#method.write_i16_into">write_i16_into</a></li><li><a href="#method.write_i24">write_i24</a></li><li><a href="#method.write_i32">write_i32</a></li><li><a href="#method.write_i32_into">write_i32_into</a></li><li><a href="#method.write_i48">write_i48</a></li><li><a href="#method.write_i64">write_i64</a></li><li><a href="#method.write_i64_into">write_i64_into</a></li><li><a href="#method.write_i8_into">write_i8_into</a></li><li><a href="#method.write_int">write_int</a></li><li><a href="#method.write_int128">write_int128</a></li><li><a href="#method.write_u24">write_u24</a></li><li><a href="#method.write_u48">write_u48</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In byteorder</a></h2></div></nav><main><div class="width-limiter"><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"><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="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="index.html">byteorder</a>::<wbr><a class="trait" 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></h1><span class="out-of-band"><a class="srclink" href="../src/byteorder/lib.rs.html#208-1788">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ByteOrder: Clone + Copy + Debug + Default + Eq + Hash + Ord + PartialEq + PartialOrd + Sealed { |
| <details class="rustdoc-toggle type-contents-toggle"><summary class="hideme"><span>Show 69 methods</span></summary> fn <a href="#tymethod.read_u16" class="fnname">read_u16</a>(buf: &[u8]) -> u16; |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_u32" class="fnname">read_u32</a>(buf: &[u8]) -> u32; |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_u64" class="fnname">read_u64</a>(buf: &[u8]) -> u64; |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_u128" class="fnname">read_u128</a>(buf: &[u8]) -> u128; |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_uint" class="fnname">read_uint</a>(buf: &[u8], nbytes: usize) -> u64; |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_uint128" class="fnname">read_uint128</a>(buf: &[u8], nbytes: usize) -> u128; |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u16" class="fnname">write_u16</a>(buf: &mut [u8], n: u16); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u32" class="fnname">write_u32</a>(buf: &mut [u8], n: u32); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u64" class="fnname">write_u64</a>(buf: &mut [u8], n: u64); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u128" class="fnname">write_u128</a>(buf: &mut [u8], n: u128); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_uint" class="fnname">write_uint</a>(buf: &mut [u8], n: u64, nbytes: usize); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_uint128" class="fnname">write_uint128</a>(buf: &mut [u8], n: u128, nbytes: usize); |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_u16_into" class="fnname">read_u16_into</a>(src: &[u8], dst: &mut [u16]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_u32_into" class="fnname">read_u32_into</a>(src: &[u8], dst: &mut [u32]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_u64_into" class="fnname">read_u64_into</a>(src: &[u8], dst: &mut [u64]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.read_u128_into" class="fnname">read_u128_into</a>(src: &[u8], dst: &mut [u128]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u16_into" class="fnname">write_u16_into</a>(src: &[u16], dst: &mut [u8]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u32_into" class="fnname">write_u32_into</a>(src: &[u32], dst: &mut [u8]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u64_into" class="fnname">write_u64_into</a>(src: &[u64], dst: &mut [u8]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.write_u128_into" class="fnname">write_u128_into</a>(src: &[u128], dst: &mut [u8]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.from_slice_u16" class="fnname">from_slice_u16</a>(numbers: &mut [u16]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.from_slice_u32" class="fnname">from_slice_u32</a>(numbers: &mut [u32]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.from_slice_u64" class="fnname">from_slice_u64</a>(numbers: &mut [u64]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.from_slice_u128" class="fnname">from_slice_u128</a>(numbers: &mut [u128]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.from_slice_f32" class="fnname">from_slice_f32</a>(numbers: &mut [f32]); |
| <span class="item-spacer"></span> fn <a href="#tymethod.from_slice_f64" class="fnname">from_slice_f64</a>(numbers: &mut [f64]); |
| |
| fn <a href="#method.read_u24" class="fnname">read_u24</a>(buf: &[u8]) -> u32 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_u48" class="fnname">read_u48</a>(buf: &[u8]) -> u64 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_u24" class="fnname">write_u24</a>(buf: &mut [u8], n: u32) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_u48" class="fnname">write_u48</a>(buf: &mut [u8], n: u64) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i16" class="fnname">read_i16</a>(buf: &[u8]) -> i16 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i24" class="fnname">read_i24</a>(buf: &[u8]) -> i32 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i32" class="fnname">read_i32</a>(buf: &[u8]) -> i32 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i48" class="fnname">read_i48</a>(buf: &[u8]) -> i64 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i64" class="fnname">read_i64</a>(buf: &[u8]) -> i64 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i128" class="fnname">read_i128</a>(buf: &[u8]) -> i128 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_int" class="fnname">read_int</a>(buf: &[u8], nbytes: usize) -> i64 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_int128" class="fnname">read_int128</a>(buf: &[u8], nbytes: usize) -> i128 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_f32" class="fnname">read_f32</a>(buf: &[u8]) -> f32 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_f64" class="fnname">read_f64</a>(buf: &[u8]) -> f64 { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i16" class="fnname">write_i16</a>(buf: &mut [u8], n: i16) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i24" class="fnname">write_i24</a>(buf: &mut [u8], n: i32) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i32" class="fnname">write_i32</a>(buf: &mut [u8], n: i32) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i48" class="fnname">write_i48</a>(buf: &mut [u8], n: i64) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i64" class="fnname">write_i64</a>(buf: &mut [u8], n: i64) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i128" class="fnname">write_i128</a>(buf: &mut [u8], n: i128) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_int" class="fnname">write_int</a>(buf: &mut [u8], n: i64, nbytes: usize) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_int128" class="fnname">write_int128</a>(buf: &mut [u8], n: i128, nbytes: usize) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_f32" class="fnname">write_f32</a>(buf: &mut [u8], n: f32) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_f64" class="fnname">write_f64</a>(buf: &mut [u8], n: f64) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i16_into" class="fnname">read_i16_into</a>(src: &[u8], dst: &mut [i16]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i32_into" class="fnname">read_i32_into</a>(src: &[u8], dst: &mut [i32]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i64_into" class="fnname">read_i64_into</a>(src: &[u8], dst: &mut [i64]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_i128_into" class="fnname">read_i128_into</a>(src: &[u8], dst: &mut [i128]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_f32_into" class="fnname">read_f32_into</a>(src: &[u8], dst: &mut [f32]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_f32_into_unchecked" class="fnname">read_f32_into_unchecked</a>(src: &[u8], dst: &mut [f32]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_f64_into" class="fnname">read_f64_into</a>(src: &[u8], dst: &mut [f64]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.read_f64_into_unchecked" class="fnname">read_f64_into_unchecked</a>(src: &[u8], dst: &mut [f64]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i8_into" class="fnname">write_i8_into</a>(src: &[i8], dst: &mut [u8]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i16_into" class="fnname">write_i16_into</a>(src: &[i16], dst: &mut [u8]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i32_into" class="fnname">write_i32_into</a>(src: &[i32], dst: &mut [u8]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i64_into" class="fnname">write_i64_into</a>(src: &[i64], dst: &mut [u8]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_i128_into" class="fnname">write_i128_into</a>(src: &[i128], dst: &mut [u8]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_f32_into" class="fnname">write_f32_into</a>(src: &[f32], dst: &mut [u8]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.write_f64_into" class="fnname">write_f64_into</a>(src: &[f64], dst: &mut [u8]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.from_slice_i16" class="fnname">from_slice_i16</a>(src: &mut [i16]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.from_slice_i32" class="fnname">from_slice_i32</a>(src: &mut [i32]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.from_slice_i64" class="fnname">from_slice_i64</a>(src: &mut [i64]) { ... } |
| <span class="item-spacer"></span> fn <a href="#method.from_slice_i128" class="fnname">from_slice_i128</a>(src: &mut [i128]) { ... } |
| </details>}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>ByteOrder</code> describes types that can serialize integers as bytes.</p> |
| <p>Note that <code>Self</code> does not appear anywhere in this trait’s definition! |
| Therefore, in order to use it, you’ll need to use syntax like |
| <code>T::read_u16(&[0, 1])</code> where <code>T</code> implements <code>ByteOrder</code>.</p> |
| <p>This crate provides two types that implement <code>ByteOrder</code>: <a href="enum.BigEndian.html"><code>BigEndian</code></a> |
| and <a href="enum.LittleEndian.html"><code>LittleEndian</code></a>. |
| This trait is sealed and cannot be implemented for callers to avoid |
| breaking backwards compatibility when adding new derived traits.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Write and read <code>u32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::write_u32(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u32(<span class="kw-2">&</span>buf));</code></pre></div> |
| <p>Write and read <code>i16</code> numbers in big endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">2</span>]; |
| BigEndian::write_i16(<span class="kw-2">&mut </span>buf, -<span class="number">5_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">5_000</span>, BigEndian::read_i16(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u16" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#225">source</a><h4 class="code-header">fn <a href="#tymethod.read_u16" class="fnname">read_u16</a>(buf: &[u8]) -> u16</h4></section></summary><div class="docblock"><p>Reads an unsigned 16 bit integer from <code>buf</code>.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 2</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#265">source</a><h4 class="code-header">fn <a href="#tymethod.read_u32" class="fnname">read_u32</a>(buf: &[u8]) -> u32</h4></section></summary><div class="docblock"><p>Reads an unsigned 32 bit integer from <code>buf</code>.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 4</code>.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <p>Write and read <code>u32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::write_u32(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u32(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#305">source</a><h4 class="code-header">fn <a href="#tymethod.read_u64" class="fnname">read_u64</a>(buf: &[u8]) -> u64</h4></section></summary><div class="docblock"><p>Reads an unsigned 64 bit integer from <code>buf</code>.</p> |
| <h5 id="panics-2"><a href="#panics-2">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 8</code>.</p> |
| <h5 id="examples-2"><a href="#examples-2">Examples</a></h5> |
| <p>Write and read <code>u64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">8</span>]; |
| LittleEndian::write_u64(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u64(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#324">source</a><h4 class="code-header">fn <a href="#tymethod.read_u128" class="fnname">read_u128</a>(buf: &[u8]) -> u128</h4></section></summary><div class="docblock"><p>Reads an unsigned 128 bit integer from <code>buf</code>.</p> |
| <h5 id="panics-3"><a href="#panics-3">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 16</code>.</p> |
| <h5 id="examples-3"><a href="#examples-3">Examples</a></h5> |
| <p>Write and read <code>u128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">16</span>]; |
| LittleEndian::write_u128(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u128(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_uint" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#344">source</a><h4 class="code-header">fn <a href="#tymethod.read_uint" class="fnname">read_uint</a>(buf: &[u8], nbytes: usize) -> u64</h4></section></summary><div class="docblock"><p>Reads an unsigned n-bytes integer from <code>buf</code>.</p> |
| <h5 id="panics-4"><a href="#panics-4">Panics</a></h5> |
| <p>Panics when <code>nbytes < 1</code> or <code>nbytes > 8</code> or |
| <code>buf.len() < nbytes</code></p> |
| <h5 id="examples-4"><a href="#examples-4">Examples</a></h5> |
| <p>Write and read an n-byte number in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_uint(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_uint(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_uint128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#364">source</a><h4 class="code-header">fn <a href="#tymethod.read_uint128" class="fnname">read_uint128</a>(buf: &[u8], nbytes: usize) -> u128</h4></section></summary><div class="docblock"><p>Reads an unsigned n-bytes integer from <code>buf</code>.</p> |
| <h5 id="panics-5"><a href="#panics-5">Panics</a></h5> |
| <p>Panics when <code>nbytes < 1</code> or <code>nbytes > 16</code> or |
| <code>buf.len() < nbytes</code></p> |
| <h5 id="examples-5"><a href="#examples-5">Examples</a></h5> |
| <p>Write and read an n-byte number in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_uint128(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_uint128(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u16" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#383">source</a><h4 class="code-header">fn <a href="#tymethod.write_u16" class="fnname">write_u16</a>(buf: &mut [u8], n: u16)</h4></section></summary><div class="docblock"><p>Writes an unsigned 16 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-6"><a href="#panics-6">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 2</code>.</p> |
| <h5 id="examples-6"><a href="#examples-6">Examples</a></h5> |
| <p>Write and read <code>u16</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">2</span>]; |
| LittleEndian::write_u16(<span class="kw-2">&mut </span>buf, <span class="number">1_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000</span>, LittleEndian::read_u16(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#423">source</a><h4 class="code-header">fn <a href="#tymethod.write_u32" class="fnname">write_u32</a>(buf: &mut [u8], n: u32)</h4></section></summary><div class="docblock"><p>Writes an unsigned 32 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-7"><a href="#panics-7">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 4</code>.</p> |
| <h5 id="examples-7"><a href="#examples-7">Examples</a></h5> |
| <p>Write and read <code>u32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::write_u32(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u32(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#463">source</a><h4 class="code-header">fn <a href="#tymethod.write_u64" class="fnname">write_u64</a>(buf: &mut [u8], n: u64)</h4></section></summary><div class="docblock"><p>Writes an unsigned 64 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-8"><a href="#panics-8">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 8</code>.</p> |
| <h5 id="examples-8"><a href="#examples-8">Examples</a></h5> |
| <p>Write and read <code>u64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">8</span>]; |
| LittleEndian::write_u64(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u64(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#482">source</a><h4 class="code-header">fn <a href="#tymethod.write_u128" class="fnname">write_u128</a>(buf: &mut [u8], n: u128)</h4></section></summary><div class="docblock"><p>Writes an unsigned 128 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-9"><a href="#panics-9">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 16</code>.</p> |
| <h5 id="examples-9"><a href="#examples-9">Examples</a></h5> |
| <p>Write and read <code>u128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">16</span>]; |
| LittleEndian::write_u128(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u128(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_uint" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#502">source</a><h4 class="code-header">fn <a href="#tymethod.write_uint" class="fnname">write_uint</a>(buf: &mut [u8], n: u64, nbytes: usize)</h4></section></summary><div class="docblock"><p>Writes an unsigned integer <code>n</code> to <code>buf</code> using only <code>nbytes</code>.</p> |
| <h5 id="panics-10"><a href="#panics-10">Panics</a></h5> |
| <p>If <code>n</code> is not representable in <code>nbytes</code>, or if <code>nbytes</code> is <code>> 8</code>, then |
| this method panics.</p> |
| <h5 id="examples-10"><a href="#examples-10">Examples</a></h5> |
| <p>Write and read an n-byte number in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_uint(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_uint(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_uint128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#522">source</a><h4 class="code-header">fn <a href="#tymethod.write_uint128" class="fnname">write_uint128</a>(buf: &mut [u8], n: u128, nbytes: usize)</h4></section></summary><div class="docblock"><p>Writes an unsigned integer <code>n</code> to <code>buf</code> using only <code>nbytes</code>.</p> |
| <h5 id="panics-11"><a href="#panics-11">Panics</a></h5> |
| <p>If <code>n</code> is not representable in <code>nbytes</code>, or if <code>nbytes</code> is <code>> 16</code>, then |
| this method panics.</p> |
| <h5 id="examples-11"><a href="#examples-11">Examples</a></h5> |
| <p>Write and read an n-byte number in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_uint128(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_uint128(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u16_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#993">source</a><h4 class="code-header">fn <a href="#tymethod.read_u16_into" class="fnname">read_u16_into</a>(src: &[u8], dst: &mut [u16])</h4></section></summary><div class="docblock"><p>Reads unsigned 16 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-12"><a href="#panics-12">Panics</a></h5> |
| <p>Panics when <code>src.len() != 2*dst.len()</code>.</p> |
| <h5 id="examples-12"><a href="#examples-12">Examples</a></h5> |
| <p>Write and read <code>u16</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">8</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u16_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u16_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u32_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1016">source</a><h4 class="code-header">fn <a href="#tymethod.read_u32_into" class="fnname">read_u32_into</a>(src: &[u8], dst: &mut [u32])</h4></section></summary><div class="docblock"><p>Reads unsigned 32 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-13"><a href="#panics-13">Panics</a></h5> |
| <p>Panics when <code>src.len() != 4*dst.len()</code>.</p> |
| <h5 id="examples-13"><a href="#examples-13">Examples</a></h5> |
| <p>Write and read <code>u32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u32_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u32_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u64_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1039">source</a><h4 class="code-header">fn <a href="#tymethod.read_u64_into" class="fnname">read_u64_into</a>(src: &[u8], dst: &mut [u64])</h4></section></summary><div class="docblock"><p>Reads unsigned 64 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-14"><a href="#panics-14">Panics</a></h5> |
| <p>Panics when <code>src.len() != 8*dst.len()</code>.</p> |
| <h5 id="examples-14"><a href="#examples-14">Examples</a></h5> |
| <p>Write and read <code>u64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">32</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u64_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u64_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.read_u128_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1062">source</a><h4 class="code-header">fn <a href="#tymethod.read_u128_into" class="fnname">read_u128_into</a>(src: &[u8], dst: &mut [u128])</h4></section></summary><div class="docblock"><p>Reads unsigned 128 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-15"><a href="#panics-15">Panics</a></h5> |
| <p>Panics when <code>src.len() != 16*dst.len()</code>.</p> |
| <h5 id="examples-15"><a href="#examples-15">Examples</a></h5> |
| <p>Write and read <code>u128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">64</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u128_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u128_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u16_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1324">source</a><h4 class="code-header">fn <a href="#tymethod.write_u16_into" class="fnname">write_u16_into</a>(src: &[u16], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes unsigned 16 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-16"><a href="#panics-16">Panics</a></h5> |
| <p>Panics when <code>dst.len() != 2*src.len()</code>.</p> |
| <h5 id="examples-16"><a href="#examples-16">Examples</a></h5> |
| <p>Write and read <code>u16</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">8</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u16_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u16_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u32_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1347">source</a><h4 class="code-header">fn <a href="#tymethod.write_u32_into" class="fnname">write_u32_into</a>(src: &[u32], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes unsigned 32 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-17"><a href="#panics-17">Panics</a></h5> |
| <p>Panics when <code>dst.len() != 4*src.len()</code>.</p> |
| <h5 id="examples-17"><a href="#examples-17">Examples</a></h5> |
| <p>Write and read <code>u32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u32_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u32_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u64_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1370">source</a><h4 class="code-header">fn <a href="#tymethod.write_u64_into" class="fnname">write_u64_into</a>(src: &[u64], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes unsigned 64 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-18"><a href="#panics-18">Panics</a></h5> |
| <p>Panics when <code>dst.len() != 8*src.len()</code>.</p> |
| <h5 id="examples-18"><a href="#examples-18">Examples</a></h5> |
| <p>Write and read <code>u64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">32</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u64_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u64_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.write_u128_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1393">source</a><h4 class="code-header">fn <a href="#tymethod.write_u128_into" class="fnname">write_u128_into</a>(src: &[u128], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes unsigned 128 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-19"><a href="#panics-19">Panics</a></h5> |
| <p>Panics when <code>dst.len() != 16*src.len()</code>.</p> |
| <h5 id="examples-19"><a href="#examples-19">Examples</a></h5> |
| <p>Write and read <code>u128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">64</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_u128_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_u128_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_slice_u16" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1616">source</a><h4 class="code-header">fn <a href="#tymethod.from_slice_u16" class="fnname">from_slice_u16</a>(numbers: &mut [u16])</h4></section></summary><div class="docblock"><p>Converts the given slice of unsigned 16 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-20"><a href="#examples-20">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">65000</span>]; |
| BigEndian::from_slice_u16(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5u16</span>.to_be(), <span class="number">65000u16</span>.to_be()]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_slice_u32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1635">source</a><h4 class="code-header">fn <a href="#tymethod.from_slice_u32" class="fnname">from_slice_u32</a>(numbers: &mut [u32])</h4></section></summary><div class="docblock"><p>Converts the given slice of unsigned 32 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-21"><a href="#examples-21">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">65000</span>]; |
| BigEndian::from_slice_u32(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5u32</span>.to_be(), <span class="number">65000u32</span>.to_be()]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_slice_u64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1654">source</a><h4 class="code-header">fn <a href="#tymethod.from_slice_u64" class="fnname">from_slice_u64</a>(numbers: &mut [u64])</h4></section></summary><div class="docblock"><p>Converts the given slice of unsigned 64 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-22"><a href="#examples-22">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">65000</span>]; |
| BigEndian::from_slice_u64(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5u64</span>.to_be(), <span class="number">65000u64</span>.to_be()]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_slice_u128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1673">source</a><h4 class="code-header">fn <a href="#tymethod.from_slice_u128" class="fnname">from_slice_u128</a>(numbers: &mut [u128])</h4></section></summary><div class="docblock"><p>Converts the given slice of unsigned 128 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-23"><a href="#examples-23">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">65000</span>]; |
| BigEndian::from_slice_u128(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5u128</span>.to_be(), <span class="number">65000u128</span>.to_be()]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_slice_f32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1780">source</a><h4 class="code-header">fn <a href="#tymethod.from_slice_f32" class="fnname">from_slice_f32</a>(numbers: &mut [f32])</h4></section></summary><div class="docblock"><p>Converts the given slice of IEEE754 single-precision (4 bytes) floating |
| point numbers to a particular endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_slice_f64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1787">source</a><h4 class="code-header">fn <a href="#tymethod.from_slice_f64" class="fnname">from_slice_f64</a>(numbers: &mut [f64])</h4></section></summary><div class="docblock"><p>Converts the given slice of IEEE754 double-precision (8 bytes) floating |
| point numbers to a particular endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| </div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_u24" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#244-246">source</a><h4 class="code-header">fn <a href="#method.read_u24" class="fnname">read_u24</a>(buf: &[u8]) -> u32</h4></section></summary><div class="docblock"><p>Reads an unsigned 24 bit integer from <code>buf</code>, stored in u32.</p> |
| <h5 id="panics-20"><a href="#panics-20">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 3</code>.</p> |
| <h5 id="examples-24"><a href="#examples-24">Examples</a></h5> |
| <p>Write and read 24 bit <code>u32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_u24(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u24(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_u48" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#284-286">source</a><h4 class="code-header">fn <a href="#method.read_u48" class="fnname">read_u48</a>(buf: &[u8]) -> u64</h4></section></summary><div class="docblock"><p>Reads an unsigned 48 bit integer from <code>buf</code>, stored in u64.</p> |
| <h5 id="panics-21"><a href="#panics-21">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 6</code>.</p> |
| <h5 id="examples-25"><a href="#examples-25">Examples</a></h5> |
| <p>Write and read 48 bit <code>u64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">6</span>]; |
| LittleEndian::write_u48(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000_000_000</span>, LittleEndian::read_u48(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_u24" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#402-404">source</a><h4 class="code-header">fn <a href="#method.write_u24" class="fnname">write_u24</a>(buf: &mut [u8], n: u32)</h4></section></summary><div class="docblock"><p>Writes an unsigned 24 bit integer <code>n</code> to <code>buf</code>, stored in u32.</p> |
| <h5 id="panics-22"><a href="#panics-22">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 3</code>.</p> |
| <h5 id="examples-26"><a href="#examples-26">Examples</a></h5> |
| <p>Write and read 24 bit <code>u32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_u24(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000</span>, LittleEndian::read_u24(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_u48" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#442-444">source</a><h4 class="code-header">fn <a href="#method.write_u48" class="fnname">write_u48</a>(buf: &mut [u8], n: u64)</h4></section></summary><div class="docblock"><p>Writes an unsigned 48 bit integer <code>n</code> to <code>buf</code>, stored in u64.</p> |
| <h5 id="panics-23"><a href="#panics-23">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 6</code>.</p> |
| <h5 id="examples-27"><a href="#examples-27">Examples</a></h5> |
| <p>Write and read 48 bit <code>u64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">6</span>]; |
| LittleEndian::write_u48(<span class="kw-2">&mut </span>buf, <span class="number">1_000_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(<span class="number">1_000_000_000_000</span>, LittleEndian::read_u48(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i16" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#542-544">source</a><h4 class="code-header">fn <a href="#method.read_i16" class="fnname">read_i16</a>(buf: &[u8]) -> i16</h4></section></summary><div class="docblock"><p>Reads a signed 16 bit integer from <code>buf</code>.</p> |
| <h5 id="panics-24"><a href="#panics-24">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 2</code>.</p> |
| <h5 id="examples-28"><a href="#examples-28">Examples</a></h5> |
| <p>Write and read <code>i16</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">2</span>]; |
| LittleEndian::write_i16(<span class="kw-2">&mut </span>buf, -<span class="number">1_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000</span>, LittleEndian::read_i16(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i24" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#564-566">source</a><h4 class="code-header">fn <a href="#method.read_i24" class="fnname">read_i24</a>(buf: &[u8]) -> i32</h4></section></summary><div class="docblock"><p>Reads a signed 24 bit integer from <code>buf</code>, stored in i32.</p> |
| <h5 id="panics-25"><a href="#panics-25">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 3</code>.</p> |
| <h5 id="examples-29"><a href="#examples-29">Examples</a></h5> |
| <p>Write and read 24 bit <code>i32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_i24(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000</span>, LittleEndian::read_i24(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#586-588">source</a><h4 class="code-header">fn <a href="#method.read_i32" class="fnname">read_i32</a>(buf: &[u8]) -> i32</h4></section></summary><div class="docblock"><p>Reads a signed 32 bit integer from <code>buf</code>.</p> |
| <h5 id="panics-26"><a href="#panics-26">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 4</code>.</p> |
| <h5 id="examples-30"><a href="#examples-30">Examples</a></h5> |
| <p>Write and read <code>i32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::write_i32(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000</span>, LittleEndian::read_i32(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i48" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#608-610">source</a><h4 class="code-header">fn <a href="#method.read_i48" class="fnname">read_i48</a>(buf: &[u8]) -> i64</h4></section></summary><div class="docblock"><p>Reads a signed 48 bit integer from <code>buf</code>, stored in i64.</p> |
| <h5 id="panics-27"><a href="#panics-27">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 6</code>.</p> |
| <h5 id="examples-31"><a href="#examples-31">Examples</a></h5> |
| <p>Write and read 48 bit <code>i64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">6</span>]; |
| LittleEndian::write_i48(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000_000_000</span>, LittleEndian::read_i48(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#630-632">source</a><h4 class="code-header">fn <a href="#method.read_i64" class="fnname">read_i64</a>(buf: &[u8]) -> i64</h4></section></summary><div class="docblock"><p>Reads a signed 64 bit integer from <code>buf</code>.</p> |
| <h5 id="panics-28"><a href="#panics-28">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 8</code>.</p> |
| <h5 id="examples-32"><a href="#examples-32">Examples</a></h5> |
| <p>Write and read <code>i64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">8</span>]; |
| LittleEndian::write_i64(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000_000</span>, LittleEndian::read_i64(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#652-654">source</a><h4 class="code-header">fn <a href="#method.read_i128" class="fnname">read_i128</a>(buf: &[u8]) -> i128</h4></section></summary><div class="docblock"><p>Reads a signed 128 bit integer from <code>buf</code>.</p> |
| <h5 id="panics-29"><a href="#panics-29">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 16</code>.</p> |
| <h5 id="examples-33"><a href="#examples-33">Examples</a></h5> |
| <p>Write and read <code>i128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">16</span>]; |
| LittleEndian::write_i128(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000_000</span>, LittleEndian::read_i128(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_int" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#675-677">source</a><h4 class="code-header">fn <a href="#method.read_int" class="fnname">read_int</a>(buf: &[u8], nbytes: usize) -> i64</h4></section></summary><div class="docblock"><p>Reads a signed n-bytes integer from <code>buf</code>.</p> |
| <h5 id="panics-30"><a href="#panics-30">Panics</a></h5> |
| <p>Panics when <code>nbytes < 1</code> or <code>nbytes > 8</code> or |
| <code>buf.len() < nbytes</code></p> |
| <h5 id="examples-34"><a href="#examples-34">Examples</a></h5> |
| <p>Write and read n-length signed numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_int(<span class="kw-2">&mut </span>buf, -<span class="number">1_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000</span>, LittleEndian::read_int(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_int128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#698-700">source</a><h4 class="code-header">fn <a href="#method.read_int128" class="fnname">read_int128</a>(buf: &[u8], nbytes: usize) -> i128</h4></section></summary><div class="docblock"><p>Reads a signed n-bytes integer from <code>buf</code>.</p> |
| <h5 id="panics-31"><a href="#panics-31">Panics</a></h5> |
| <p>Panics when <code>nbytes < 1</code> or <code>nbytes > 16</code> or |
| <code>buf.len() < nbytes</code></p> |
| <h5 id="examples-35"><a href="#examples-35">Examples</a></h5> |
| <p>Write and read n-length signed numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_int128(<span class="kw-2">&mut </span>buf, -<span class="number">1_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000</span>, LittleEndian::read_int128(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_f32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#721-723">source</a><h4 class="code-header">fn <a href="#method.read_f32" class="fnname">read_f32</a>(buf: &[u8]) -> f32</h4></section></summary><div class="docblock"><p>Reads a IEEE754 single-precision (4 bytes) floating point number.</p> |
| <h5 id="panics-32"><a href="#panics-32">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 4</code>.</p> |
| <h5 id="examples-36"><a href="#examples-36">Examples</a></h5> |
| <p>Write and read <code>f32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span>e = <span class="number">2.71828</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::write_f32(<span class="kw-2">&mut </span>buf, e); |
| <span class="macro">assert_eq!</span>(e, LittleEndian::read_f32(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_f64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#744-746">source</a><h4 class="code-header">fn <a href="#method.read_f64" class="fnname">read_f64</a>(buf: &[u8]) -> f64</h4></section></summary><div class="docblock"><p>Reads a IEEE754 double-precision (8 bytes) floating point number.</p> |
| <h5 id="panics-33"><a href="#panics-33">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 8</code>.</p> |
| <h5 id="examples-37"><a href="#examples-37">Examples</a></h5> |
| <p>Write and read <code>f64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span>phi = <span class="number">1.6180339887</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">8</span>]; |
| LittleEndian::write_f64(<span class="kw-2">&mut </span>buf, phi); |
| <span class="macro">assert_eq!</span>(phi, LittleEndian::read_f64(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i16" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#766-768">source</a><h4 class="code-header">fn <a href="#method.write_i16" class="fnname">write_i16</a>(buf: &mut [u8], n: i16)</h4></section></summary><div class="docblock"><p>Writes a signed 16 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-34"><a href="#panics-34">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 2</code>.</p> |
| <h5 id="examples-38"><a href="#examples-38">Examples</a></h5> |
| <p>Write and read <code>i16</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">2</span>]; |
| LittleEndian::write_i16(<span class="kw-2">&mut </span>buf, -<span class="number">1_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000</span>, LittleEndian::read_i16(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i24" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#788-790">source</a><h4 class="code-header">fn <a href="#method.write_i24" class="fnname">write_i24</a>(buf: &mut [u8], n: i32)</h4></section></summary><div class="docblock"><p>Writes a signed 24 bit integer <code>n</code> to <code>buf</code>, stored in i32.</p> |
| <h5 id="panics-35"><a href="#panics-35">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 3</code>.</p> |
| <h5 id="examples-39"><a href="#examples-39">Examples</a></h5> |
| <p>Write and read 24 bit <code>i32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_i24(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000</span>, LittleEndian::read_i24(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#810-812">source</a><h4 class="code-header">fn <a href="#method.write_i32" class="fnname">write_i32</a>(buf: &mut [u8], n: i32)</h4></section></summary><div class="docblock"><p>Writes a signed 32 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-36"><a href="#panics-36">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 4</code>.</p> |
| <h5 id="examples-40"><a href="#examples-40">Examples</a></h5> |
| <p>Write and read <code>i32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::write_i32(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000</span>, LittleEndian::read_i32(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i48" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#832-834">source</a><h4 class="code-header">fn <a href="#method.write_i48" class="fnname">write_i48</a>(buf: &mut [u8], n: i64)</h4></section></summary><div class="docblock"><p>Writes a signed 48 bit integer <code>n</code> to <code>buf</code>, stored in i64.</p> |
| <h5 id="panics-37"><a href="#panics-37">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 6</code>.</p> |
| <h5 id="examples-41"><a href="#examples-41">Examples</a></h5> |
| <p>Write and read 48 bit <code>i64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">6</span>]; |
| LittleEndian::write_i48(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000_000_000</span>, LittleEndian::read_i48(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#854-856">source</a><h4 class="code-header">fn <a href="#method.write_i64" class="fnname">write_i64</a>(buf: &mut [u8], n: i64)</h4></section></summary><div class="docblock"><p>Writes a signed 64 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-38"><a href="#panics-38">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 8</code>.</p> |
| <h5 id="examples-42"><a href="#examples-42">Examples</a></h5> |
| <p>Write and read <code>i64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">8</span>]; |
| LittleEndian::write_i64(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000_000</span>, LittleEndian::read_i64(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#876-878">source</a><h4 class="code-header">fn <a href="#method.write_i128" class="fnname">write_i128</a>(buf: &mut [u8], n: i128)</h4></section></summary><div class="docblock"><p>Writes a signed 128 bit integer <code>n</code> to <code>buf</code>.</p> |
| <h5 id="panics-39"><a href="#panics-39">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 16</code>.</p> |
| <h5 id="examples-43"><a href="#examples-43">Examples</a></h5> |
| <p>Write and read n-byte <code>i128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">16</span>]; |
| LittleEndian::write_i128(<span class="kw-2">&mut </span>buf, -<span class="number">1_000_000_000</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000_000_000</span>, LittleEndian::read_i128(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_int" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#899-901">source</a><h4 class="code-header">fn <a href="#method.write_int" class="fnname">write_int</a>(buf: &mut [u8], n: i64, nbytes: usize)</h4></section></summary><div class="docblock"><p>Writes a signed integer <code>n</code> to <code>buf</code> using only <code>nbytes</code>.</p> |
| <h5 id="panics-40"><a href="#panics-40">Panics</a></h5> |
| <p>If <code>n</code> is not representable in <code>nbytes</code>, or if <code>nbytes</code> is <code>> 8</code>, then |
| this method panics.</p> |
| <h5 id="examples-44"><a href="#examples-44">Examples</a></h5> |
| <p>Write and read an n-byte number in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_int(<span class="kw-2">&mut </span>buf, -<span class="number">1_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000</span>, LittleEndian::read_int(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_int128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#922-924">source</a><h4 class="code-header">fn <a href="#method.write_int128" class="fnname">write_int128</a>(buf: &mut [u8], n: i128, nbytes: usize)</h4></section></summary><div class="docblock"><p>Writes a signed integer <code>n</code> to <code>buf</code> using only <code>nbytes</code>.</p> |
| <h5 id="panics-41"><a href="#panics-41">Panics</a></h5> |
| <p>If <code>n</code> is not representable in <code>nbytes</code>, or if <code>nbytes</code> is <code>> 16</code>, then |
| this method panics.</p> |
| <h5 id="examples-45"><a href="#examples-45">Examples</a></h5> |
| <p>Write and read n-length signed numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">3</span>]; |
| LittleEndian::write_int128(<span class="kw-2">&mut </span>buf, -<span class="number">1_000</span>, <span class="number">3</span>); |
| <span class="macro">assert_eq!</span>(-<span class="number">1_000</span>, LittleEndian::read_int128(<span class="kw-2">&</span>buf, <span class="number">3</span>));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_f32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#945-947">source</a><h4 class="code-header">fn <a href="#method.write_f32" class="fnname">write_f32</a>(buf: &mut [u8], n: f32)</h4></section></summary><div class="docblock"><p>Writes a IEEE754 single-precision (4 bytes) floating point number.</p> |
| <h5 id="panics-42"><a href="#panics-42">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 4</code>.</p> |
| <h5 id="examples-46"><a href="#examples-46">Examples</a></h5> |
| <p>Write and read <code>f32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span>e = <span class="number">2.71828</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::write_f32(<span class="kw-2">&mut </span>buf, e); |
| <span class="macro">assert_eq!</span>(e, LittleEndian::read_f32(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_f64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#968-970">source</a><h4 class="code-header">fn <a href="#method.write_f64" class="fnname">write_f64</a>(buf: &mut [u8], n: f64)</h4></section></summary><div class="docblock"><p>Writes a IEEE754 double-precision (8 bytes) floating point number.</p> |
| <h5 id="panics-43"><a href="#panics-43">Panics</a></h5> |
| <p>Panics when <code>buf.len() < 8</code>.</p> |
| <h5 id="examples-47"><a href="#examples-47">Examples</a></h5> |
| <p>Write and read <code>f64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span>phi = <span class="number">1.6180339887</span>; |
| <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">8</span>]; |
| LittleEndian::write_f64(<span class="kw-2">&mut </span>buf, phi); |
| <span class="macro">assert_eq!</span>(phi, LittleEndian::read_f64(<span class="kw-2">&</span>buf));</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i16_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1086-1091">source</a><h4 class="code-header">fn <a href="#method.read_i16_into" class="fnname">read_i16_into</a>(src: &[u8], dst: &mut [i16])</h4></section></summary><div class="docblock"><p>Reads signed 16 bit integers from <code>src</code> to <code>dst</code>.</p> |
| <h5 id="panics-44"><a href="#panics-44">Panics</a></h5> |
| <p>Panics when <code>buf.len() != 2*dst.len()</code>.</p> |
| <h5 id="examples-48"><a href="#examples-48">Examples</a></h5> |
| <p>Write and read <code>i16</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">8</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0x0f</span>, <span class="number">0xee</span>]; |
| LittleEndian::write_i16_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i16_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i32_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1115-1120">source</a><h4 class="code-header">fn <a href="#method.read_i32_into" class="fnname">read_i32_into</a>(src: &[u8], dst: &mut [i32])</h4></section></summary><div class="docblock"><p>Reads signed 32 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-45"><a href="#panics-45">Panics</a></h5> |
| <p>Panics when <code>src.len() != 4*dst.len()</code>.</p> |
| <h5 id="examples-49"><a href="#examples-49">Examples</a></h5> |
| <p>Write and read <code>i32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_i32_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i32_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i64_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1144-1149">source</a><h4 class="code-header">fn <a href="#method.read_i64_into" class="fnname">read_i64_into</a>(src: &[u8], dst: &mut [i64])</h4></section></summary><div class="docblock"><p>Reads signed 64 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-46"><a href="#panics-46">Panics</a></h5> |
| <p>Panics when <code>src.len() != 8*dst.len()</code>.</p> |
| <h5 id="examples-50"><a href="#examples-50">Examples</a></h5> |
| <p>Write and read <code>i64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">32</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_i64_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i64_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_i128_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1173-1178">source</a><h4 class="code-header">fn <a href="#method.read_i128_into" class="fnname">read_i128_into</a>(src: &[u8], dst: &mut [i128])</h4></section></summary><div class="docblock"><p>Reads signed 128 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-47"><a href="#panics-47">Panics</a></h5> |
| <p>Panics when <code>src.len() != 16*dst.len()</code>.</p> |
| <h5 id="examples-51"><a href="#examples-51">Examples</a></h5> |
| <p>Write and read <code>i128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">64</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_i128_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i128_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_f32_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1203-1208">source</a><h4 class="code-header">fn <a href="#method.read_f32_into" class="fnname">read_f32_into</a>(src: &[u8], dst: &mut [f32])</h4></section></summary><div class="docblock"><p>Reads IEEE754 single-precision (4 bytes) floating point numbers from |
| <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-48"><a href="#panics-48">Panics</a></h5> |
| <p>Panics when <code>src.len() != 4*dst.len()</code>.</p> |
| <h5 id="examples-52"><a href="#examples-52">Examples</a></h5> |
| <p>Write and read <code>f32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">31.312e31</span>, -<span class="number">11.32e19</span>]; |
| LittleEndian::write_f32_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0.0</span>; <span class="number">4</span>]; |
| LittleEndian::read_f32_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_f32_into_unchecked" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1237-1239">source</a><h4 class="code-header">fn <a href="#method.read_f32_into_unchecked" class="fnname">read_f32_into_unchecked</a>(src: &[u8], dst: &mut [f32])</h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 1.3.0: please use <code>read_f32_into</code> instead</span></div></span><div class="docblock"><p><strong>DEPRECATED</strong>.</p> |
| <p>This method is deprecated. Use <code>read_f32_into</code> instead. |
| Reads IEEE754 single-precision (4 bytes) floating point numbers from |
| <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-49"><a href="#panics-49">Panics</a></h5> |
| <p>Panics when <code>src.len() != 4*dst.len()</code>.</p> |
| <h5 id="examples-53"><a href="#examples-53">Examples</a></h5> |
| <p>Write and read <code>f32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">31.312e31</span>, -<span class="number">11.32e19</span>]; |
| LittleEndian::write_f32_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0.0</span>; <span class="number">4</span>]; |
| LittleEndian::read_f32_into_unchecked(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_f64_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1264-1269">source</a><h4 class="code-header">fn <a href="#method.read_f64_into" class="fnname">read_f64_into</a>(src: &[u8], dst: &mut [f64])</h4></section></summary><div class="docblock"><p>Reads IEEE754 single-precision (4 bytes) floating point numbers from |
| <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-50"><a href="#panics-50">Panics</a></h5> |
| <p>Panics when <code>src.len() != 8*dst.len()</code>.</p> |
| <h5 id="examples-54"><a href="#examples-54">Examples</a></h5> |
| <p>Write and read <code>f64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">32</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">31.312e211</span>, -<span class="number">11.32e91</span>]; |
| LittleEndian::write_f64_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0.0</span>; <span class="number">4</span>]; |
| LittleEndian::read_f64_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.read_f64_into_unchecked" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1299-1301">source</a><h4 class="code-header">fn <a href="#method.read_f64_into_unchecked" class="fnname">read_f64_into_unchecked</a>(src: &[u8], dst: &mut [f64])</h4></section></summary><span class="item-info"><div class="stab deprecated"><span class="emoji">👎</span><span>Deprecated since 1.3.0: please use <code>read_f64_into</code> instead</span></div></span><div class="docblock"><p><strong>DEPRECATED</strong>.</p> |
| <p>This method is deprecated. Use <code>read_f64_into</code> instead.</p> |
| <p>Reads IEEE754 single-precision (4 bytes) floating point numbers from |
| <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-51"><a href="#panics-51">Panics</a></h5> |
| <p>Panics when <code>src.len() != 8*dst.len()</code>.</p> |
| <h5 id="examples-55"><a href="#examples-55">Examples</a></h5> |
| <p>Write and read <code>f64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">32</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">31.312e211</span>, -<span class="number">11.32e91</span>]; |
| LittleEndian::write_f64_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0.0</span>; <span class="number">4</span>]; |
| LittleEndian::read_f64_into_unchecked(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i8_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1422-1427">source</a><h4 class="code-header">fn <a href="#method.write_i8_into" class="fnname">write_i8_into</a>(src: &[i8], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes signed 8 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <p>Note that since each <code>i8</code> is a single byte, no byte order conversions |
| are used. This method is included because it provides a safe, simple |
| way for the caller to write from a <code>&[i8]</code> buffer. (Without this |
| method, the caller would have to either use <code>unsafe</code> code or convert |
| each byte to <code>u8</code> individually.)</p> |
| <h5 id="panics-52"><a href="#panics-52">Panics</a></h5> |
| <p>Panics when <code>buf.len() != src.len()</code>.</p> |
| <h5 id="examples-56"><a href="#examples-56">Examples</a></h5> |
| <p>Write and read <code>i8</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian, ReadBytesExt}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">4</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf</span>, <span class="number">0xe</span>]; |
| LittleEndian::write_i8_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| bytes.as_ref().read_i8_into(<span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i16_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1450-1455">source</a><h4 class="code-header">fn <a href="#method.write_i16_into" class="fnname">write_i16_into</a>(src: &[i16], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes signed 16 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-53"><a href="#panics-53">Panics</a></h5> |
| <p>Panics when <code>buf.len() != 2*src.len()</code>.</p> |
| <h5 id="examples-57"><a href="#examples-57">Examples</a></h5> |
| <p>Write and read <code>i16</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">8</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0x0f</span>, <span class="number">0xee</span>]; |
| LittleEndian::write_i16_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i16_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i32_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1478-1483">source</a><h4 class="code-header">fn <a href="#method.write_i32_into" class="fnname">write_i32_into</a>(src: &[i32], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes signed 32 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-54"><a href="#panics-54">Panics</a></h5> |
| <p>Panics when <code>dst.len() != 4*src.len()</code>.</p> |
| <h5 id="examples-58"><a href="#examples-58">Examples</a></h5> |
| <p>Write and read <code>i32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_i32_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i32_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i64_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1506-1511">source</a><h4 class="code-header">fn <a href="#method.write_i64_into" class="fnname">write_i64_into</a>(src: &[i64], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes signed 64 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-55"><a href="#panics-55">Panics</a></h5> |
| <p>Panics when <code>dst.len() != 8*src.len()</code>.</p> |
| <h5 id="examples-59"><a href="#examples-59">Examples</a></h5> |
| <p>Write and read <code>i64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">32</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_i64_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i64_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_i128_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1534-1539">source</a><h4 class="code-header">fn <a href="#method.write_i128_into" class="fnname">write_i128_into</a>(src: &[i128], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes signed 128 bit integers from <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-56"><a href="#panics-56">Panics</a></h5> |
| <p>Panics when <code>dst.len() != 16*src.len()</code>.</p> |
| <h5 id="examples-60"><a href="#examples-60">Examples</a></h5> |
| <p>Write and read <code>i128</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">64</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">0xf00f</span>, <span class="number">0xffee</span>]; |
| LittleEndian::write_i128_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0</span>; <span class="number">4</span>]; |
| LittleEndian::read_i128_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_f32_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1563-1568">source</a><h4 class="code-header">fn <a href="#method.write_f32_into" class="fnname">write_f32_into</a>(src: &[f32], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes IEEE754 single-precision (4 bytes) floating point numbers from |
| <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-57"><a href="#panics-57">Panics</a></h5> |
| <p>Panics when <code>src.len() != 4*dst.len()</code>.</p> |
| <h5 id="examples-61"><a href="#examples-61">Examples</a></h5> |
| <p>Write and read <code>f32</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">16</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">31.312e31</span>, -<span class="number">11.32e19</span>]; |
| LittleEndian::write_f32_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0.0</span>; <span class="number">4</span>]; |
| LittleEndian::read_f32_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.write_f64_into" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1592-1597">source</a><h4 class="code-header">fn <a href="#method.write_f64_into" class="fnname">write_f64_into</a>(src: &[f64], dst: &mut [u8])</h4></section></summary><div class="docblock"><p>Writes IEEE754 double-precision (8 bytes) floating point numbers from |
| <code>src</code> into <code>dst</code>.</p> |
| <h5 id="panics-58"><a href="#panics-58">Panics</a></h5> |
| <p>Panics when <code>src.len() != 8*dst.len()</code>.</p> |
| <h5 id="examples-62"><a href="#examples-62">Examples</a></h5> |
| <p>Write and read <code>f64</code> numbers in little endian order:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, LittleEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>bytes = [<span class="number">0</span>; <span class="number">32</span>]; |
| <span class="kw">let </span>numbers_given = [<span class="number">1.0</span>, <span class="number">2.0</span>, <span class="number">31.312e211</span>, -<span class="number">11.32e91</span>]; |
| LittleEndian::write_f64_into(<span class="kw-2">&</span>numbers_given, <span class="kw-2">&mut </span>bytes); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers_got = [<span class="number">0.0</span>; <span class="number">4</span>]; |
| LittleEndian::read_f64_into(<span class="kw-2">&</span>bytes, <span class="kw-2">&mut </span>numbers_got); |
| <span class="macro">assert_eq!</span>(numbers_given, numbers_got);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_slice_i16" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1693-1698">source</a><h4 class="code-header">fn <a href="#method.from_slice_i16" class="fnname">from_slice_i16</a>(src: &mut [i16])</h4></section></summary><div class="docblock"><p>Converts the given slice of signed 16 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-63"><a href="#examples-63">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">6500</span>]; |
| BigEndian::from_slice_i16(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5i16</span>.to_be(), <span class="number">6500i16</span>.to_be()]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_slice_i32" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1718-1723">source</a><h4 class="code-header">fn <a href="#method.from_slice_i32" class="fnname">from_slice_i32</a>(src: &mut [i32])</h4></section></summary><div class="docblock"><p>Converts the given slice of signed 32 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-64"><a href="#examples-64">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">65000</span>]; |
| BigEndian::from_slice_i32(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5i32</span>.to_be(), <span class="number">65000i32</span>.to_be()]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_slice_i64" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1743-1748">source</a><h4 class="code-header">fn <a href="#method.from_slice_i64" class="fnname">from_slice_i64</a>(src: &mut [i64])</h4></section></summary><div class="docblock"><p>Converts the given slice of signed 64 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-65"><a href="#examples-65">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">65000</span>]; |
| BigEndian::from_slice_i64(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5i64</span>.to_be(), <span class="number">65000i64</span>.to_be()]);</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from_slice_i128" class="method has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1768-1773">source</a><h4 class="code-header">fn <a href="#method.from_slice_i128" class="fnname">from_slice_i128</a>(src: &mut [i128])</h4></section></summary><div class="docblock"><p>Converts the given slice of signed 128 bit integers to a particular |
| endianness.</p> |
| <p>If the endianness matches the endianness of the host platform, then |
| this is a no-op.</p> |
| <h5 id="examples-66"><a href="#examples-66">Examples</a></h5> |
| <p>Convert the host platform’s endianness to big-endian:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>byteorder::{ByteOrder, BigEndian}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>numbers = [<span class="number">5</span>, <span class="number">65000</span>]; |
| BigEndian::from_slice_i128(<span class="kw-2">&mut </span>numbers); |
| <span class="macro">assert_eq!</span>(numbers, [<span class="number">5i128</span>.to_be(), <span class="number">65000i128</span>.to_be()]);</code></pre></div> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-ByteOrder-for-BigEndian" class="impl has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#1970-2184">source</a><a href="#impl-ByteOrder-for-BigEndian" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ByteOrder.html" title="trait byteorder::ByteOrder">ByteOrder</a> for <a class="enum" href="enum.BigEndian.html" title="enum byteorder::BigEndian">BigEndian</a></h3></section><section id="impl-ByteOrder-for-LittleEndian" class="impl has-srclink"><a class="srclink rightside" href="../src/byteorder/lib.rs.html#2186-2384">source</a><a href="#impl-ByteOrder-for-LittleEndian" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.ByteOrder.html" title="trait byteorder::ByteOrder">ByteOrder</a> for <a class="enum" href="enum.LittleEndian.html" title="enum byteorder::LittleEndian">LittleEndian</a></h3></section></div><script src="../implementors/byteorder/trait.ByteOrder.js" async></script></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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
