edlang/gimli/leb128/index.html
2024-02-13 06:38:44 +00:00

37 lines
6.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Read and write DWARFs “Little Endian Base 128” (LEB128) variable length integer encoding."><title>gimli::leb128 - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="gimli" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../gimli/index.html">gimli</a><span class="version">0.28.1</span></h2></div><h2 class="location"><a href="#">Module leb128</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#modules">Modules</a></li></ul></section><h2><a href="../index.html">In crate gimli</a></h2></div></nav><div class="sidebar-resizer"></div>
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../gimli/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">gimli</a>::<wbr><a class="mod" href="#">leb128</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/gimli/leb128.rs.html#1-612">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Read and write DWARFs “Little Endian Base 128” (LEB128) variable length
integer encoding.</p>
<p>The implementation is a direct translation of the psuedocode in the DWARF 4
standards appendix C.</p>
<p>Read and write signed integers:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gimli::{EndianSlice, NativeEndian, leb128};
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">1024</span>];
<span class="comment">// Write to anything that implements `std::io::Write`.
</span>{
<span class="kw">let </span><span class="kw-2">mut </span>writable = <span class="kw-2">&amp;mut </span>buf[..];
leb128::write::signed(<span class="kw-2">&amp;mut </span>writable, -<span class="number">12345</span>).expect(<span class="string">"Should write number"</span>);
}
<span class="comment">// Read from anything that implements `gimli::Reader`.
</span><span class="kw">let </span><span class="kw-2">mut </span>readable = EndianSlice::new(<span class="kw-2">&amp;</span>buf[..], NativeEndian);
<span class="kw">let </span>val = leb128::read::signed(<span class="kw-2">&amp;mut </span>readable).expect(<span class="string">"Should read number"</span>);
<span class="macro">assert_eq!</span>(val, -<span class="number">12345</span>);</code></pre></div>
<p>Or read and write unsigned integers:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>gimli::{EndianSlice, NativeEndian, leb128};
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">1024</span>];
{
<span class="kw">let </span><span class="kw-2">mut </span>writable = <span class="kw-2">&amp;mut </span>buf[..];
leb128::write::unsigned(<span class="kw-2">&amp;mut </span>writable, <span class="number">98765</span>).expect(<span class="string">"Should write number"</span>);
}
<span class="kw">let </span><span class="kw-2">mut </span>readable = EndianSlice::new(<span class="kw-2">&amp;</span>buf[..], NativeEndian);
<span class="kw">let </span>val = leb128::read::unsigned(<span class="kw-2">&amp;mut </span>readable).expect(<span class="string">"Should read number"</span>);
<span class="macro">assert_eq!</span>(val, <span class="number">98765</span>);</code></pre></div>
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="read/index.html" title="mod gimli::leb128::read">read</a></div><div class="desc docblock-short">A module for reading signed and unsigned integers that have been LEB128
encoded.</div></li></ul></section></div></main></body></html>