| <!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="Fast serialization of integers."><meta name="keywords" content="rust, rustlang, rust-lang, integer_encoding"><title>integer_encoding - 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="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../integer_encoding/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="../integer_encoding/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate integer_encoding</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 1.1.7</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#traits">Traits</a></li></ul></section></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">Crate <a class="mod" href="#">integer_encoding</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/integer_encoding/lib.rs.html#1-42">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Fast serialization of integers.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>integer_encoding::<span class="kw-2">*</span>; |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">let </span>a: u32 = <span class="number">344</span>; |
| <span class="kw">let </span>encoded_byte_slice = a.encode_fixed_light(); |
| <span class="macro">assert_eq!</span>(a, u32::decode_fixed(encoded_byte_slice)); |
| <span class="macro">assert_eq!</span>(<span class="number">4</span>, encoded_byte_slice.len()); |
| |
| <span class="kw">let </span>b: i32 = -<span class="number">111</span>; |
| <span class="kw">let </span>encoded_byte_vec = b.encode_var_vec(); |
| <span class="macro">assert_eq!</span>((b, <span class="number">2</span>), i32::decode_var(<span class="kw-2">&</span>encoded_byte_vec)); |
| }</code></pre></div> |
| </div></details><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FixedInt.html" title="integer_encoding::FixedInt trait">FixedInt</a></div><div class="item-right docblock-short">FixedInt provides encoding/decoding to and from fixed int representations. |
| The emitted bytestring contains the bytes of the integer in machine endianness.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FixedIntReader.html" title="integer_encoding::FixedIntReader trait">FixedIntReader</a></div><div class="item-right docblock-short">A trait for reading FixedInts from any other <code>Reader</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.FixedIntWriter.html" title="integer_encoding::FixedIntWriter trait">FixedIntWriter</a></div><div class="item-right docblock-short">A trait for writing integers without encoding (i.e. <code>FixedInt</code>) to any <code>Write</code> type.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.VarInt.html" title="integer_encoding::VarInt trait">VarInt</a></div><div class="item-right docblock-short">Varint (variable length integer) encoding, as described in |
| https://developers.google.com/protocol-buffers/docs/encoding. |
| Uses zigzag encoding (also described there) for signed integer representation.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.VarIntReader.html" title="integer_encoding::VarIntReader trait">VarIntReader</a></div><div class="item-right docblock-short">A trait for reading VarInts from any other <code>Reader</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.VarIntWriter.html" title="integer_encoding::VarIntWriter trait">VarIntWriter</a></div><div class="item-right docblock-short">A trait for writing integers in VarInt encoding to any <code>Write</code> type. This packs encoding and |
| writing into one step.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="integer_encoding" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
