edg-l/edlang
1
1
Fork 0
mirror of https://github.com/edg-l/edlang.git synced 2024-11-10 01:58:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
edlang/gimli/index.html
edg-l 5c4cbb28c1 deploy: 4a83cfd6f9
2024-02-13 06:38:44 +00:00

31 lines
17 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="`gimli` is a library for reading and writing the DWARF debugging format."><title>gimli - 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="../crates.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 crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button></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><div class="sidebar-elems"><ul class="block">
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section></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>Crate <a class="mod" href="#">gimli</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/lib.rs.html#1-79">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><code>gimli</code> is a library for reading and writing the
<a href="https://dwarfstd.org/">DWARF debugging format</a>.</p>
<p>See the <a href="./read/index.html">read</a> and <a href="./write/index.html">write</a> modules
for examples and API documentation.</p>
<h3 id="cargo-features"><a href="#cargo-features">Cargo Features</a></h3>
<p>Cargo features that can be enabled with <code>gimli</code>:</p>
<ul>
<li>
<p><code>std</code>: Enabled by default. Use the <code>std</code> library. Disabling this feature
allows using <code>gimli</code> in embedded environments that do not have access to
<code>std</code>. Note that even when <code>std</code> is disabled, <code>gimli</code> still requires an
implementation of the <code>alloc</code> crate.</p>
</li>
<li>
<p><code>read</code>: Enabled by default. Enables the <code>read</code> module. Use of <code>std</code> is
optional.</p>
</li>
<li>
<p><code>write</code>: Enabled by default. Enables the <code>write</code> module. Always uses
the <code>std</code> library.</p>
</li>
</ul>
</div></details><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name"><code>pub use crate::<a class="mod" href="constants/index.html" title="mod gimli::constants">constants</a>::*;</code></div></li><li><div class="item-name"><code>pub use crate::<a class="mod" href="read/index.html" title="mod gimli::read">read</a>::*;</code></div></li></ul><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="constants/index.html" title="mod gimli::constants">constants</a></div><div class="desc docblock-short">Constant definitions.</div></li><li><div class="item-name"><a class="mod" href="leb128/index.html" title="mod gimli::leb128">leb128</a></div><div class="desc docblock-short">Read and write DWARF’s “Little Endian Base 128” (LEB128) variable length
integer encoding.</div></li><li><div class="item-name"><a class="mod" href="read/index.html" title="mod gimli::read">read</a></div><div class="desc docblock-short">Read DWARF debugging information.</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.AArch64.html" title="struct gimli::AArch64">AArch64</a></div><div class="desc docblock-short">ARM 64-bit (AArch64) architecture specific definitions.</div></li><li><div class="item-name"><a class="struct" href="struct.Arm.html" title="struct gimli::Arm">Arm</a></div><div class="desc docblock-short">ARM architecture specific definitions.</div></li><li><div class="item-name"><a class="struct" href="struct.BigEndian.html" title="struct gimli::BigEndian">BigEndian</a></div><div class="desc docblock-short">Big endian byte order.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugAbbrevOffset.html" title="struct gimli::DebugAbbrevOffset">DebugAbbrevOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_abbrev</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugAddrBase.html" title="struct gimli::DebugAddrBase">DebugAddrBase</a></div><div class="desc docblock-short">An offset to a set of entries in the <code>.debug_addr</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugAddrIndex.html" title="struct gimli::DebugAddrIndex">DebugAddrIndex</a></div><div class="desc docblock-short">An index into a set of addresses in the <code>.debug_addr</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugArangesOffset.html" title="struct gimli::DebugArangesOffset">DebugArangesOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_aranges</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugFrameOffset.html" title="struct gimli::DebugFrameOffset">DebugFrameOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_frame</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugInfoOffset.html" title="struct gimli::DebugInfoOffset">DebugInfoOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_info</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugLineOffset.html" title="struct gimli::DebugLineOffset">DebugLineOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_line</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugLineStrOffset.html" title="struct gimli::DebugLineStrOffset">DebugLineStrOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_line_str</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugLocListsBase.html" title="struct gimli::DebugLocListsBase">DebugLocListsBase</a></div><div class="desc docblock-short">An offset to a set of location list offsets in the <code>.debug_loclists</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugLocListsIndex.html" title="struct gimli::DebugLocListsIndex">DebugLocListsIndex</a></div><div class="desc docblock-short">An index into a set of location list offsets in the <code>.debug_loclists</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugMacinfoOffset.html" title="struct gimli::DebugMacinfoOffset">DebugMacinfoOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_macinfo</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugMacroOffset.html" title="struct gimli::DebugMacroOffset">DebugMacroOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_macro</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugRngListsBase.html" title="struct gimli::DebugRngListsBase">DebugRngListsBase</a></div><div class="desc docblock-short">An offset to a set of range list offsets in the <code>.debug_rnglists</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugRngListsIndex.html" title="struct gimli::DebugRngListsIndex">DebugRngListsIndex</a></div><div class="desc docblock-short">An index into a set of range list offsets in the <code>.debug_rnglists</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugStrOffset.html" title="struct gimli::DebugStrOffset">DebugStrOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_str</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugStrOffsetsBase.html" title="struct gimli::DebugStrOffsetsBase">DebugStrOffsetsBase</a></div><div class="desc docblock-short">An offset to a set of entries in the <code>.debug_str_offsets</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugStrOffsetsIndex.html" title="struct gimli::DebugStrOffsetsIndex">DebugStrOffsetsIndex</a></div><div class="desc docblock-short">An index into a set of entries in the <code>.debug_str_offsets</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugTypeSignature.html" title="struct gimli::DebugTypeSignature">DebugTypeSignature</a></div><div class="desc docblock-short">A type signature as used in the <code>.debug_types</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DebugTypesOffset.html" title="struct gimli::DebugTypesOffset">DebugTypesOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_types</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.DwoId.html" title="struct gimli::DwoId">DwoId</a></div><div class="desc docblock-short">An optionally-provided implementation-defined compilation unit ID to enable
split DWARF and linking a split compilation unit back together.</div></li><li><div class="item-name"><a class="struct" href="struct.EhFrameOffset.html" title="struct gimli::EhFrameOffset">EhFrameOffset</a></div><div class="desc docblock-short">An offset into the <code>.eh_frame</code> section.</div></li><li><div class="item-name"><a class="struct" href="struct.Encoding.html" title="struct gimli::Encoding">Encoding</a></div><div class="desc docblock-short">Encoding parameters that are commonly used for multiple DWARF sections.</div></li><li><div class="item-name"><a class="struct" href="struct.LineEncoding.html" title="struct gimli::LineEncoding">LineEncoding</a></div><div class="desc docblock-short">Encoding parameters for a line number program.</div></li><li><div class="item-name"><a class="struct" href="struct.LittleEndian.html" title="struct gimli::LittleEndian">LittleEndian</a></div><div class="desc docblock-short">Little endian byte order.</div></li><li><div class="item-name"><a class="struct" href="struct.LocationListsOffset.html" title="struct gimli::LocationListsOffset">LocationListsOffset</a></div><div class="desc docblock-short">An offset into either the <code>.debug_loc</code> section or the <code>.debug_loclists</code> section,
depending on the version of the unit the offset was contained in.</div></li><li><div class="item-name"><a class="struct" href="struct.LoongArch.html" title="struct gimli::LoongArch">LoongArch</a></div><div class="desc docblock-short">LoongArch architecture specific definitions.</div></li><li><div class="item-name"><a class="struct" href="struct.RangeListsOffset.html" title="struct gimli::RangeListsOffset">RangeListsOffset</a></div><div class="desc docblock-short">An offset into either the <code>.debug_ranges</code> section or the <code>.debug_rnglists</code> section,
depending on the version of the unit the offset was contained in.</div></li><li><div class="item-name"><a class="struct" href="struct.RawRangeListsOffset.html" title="struct gimli::RawRangeListsOffset">RawRangeListsOffset</a></div><div class="desc docblock-short">An offset into either the <code>.debug_ranges</code> section or the <code>.debug_rnglists</code> section,
depending on the version of the unit the offset was contained in.</div></li><li><div class="item-name"><a class="struct" href="struct.Register.html" title="struct gimli::Register">Register</a></div><div class="desc docblock-short">A DWARF register number.</div></li><li><div class="item-name"><a class="struct" href="struct.RiscV.html" title="struct gimli::RiscV">RiscV</a></div><div class="desc docblock-short">RISC-V architecture specific definitions.</div></li><li><div class="item-name"><a class="struct" href="struct.X86.html" title="struct gimli::X86">X86</a></div><div class="desc docblock-short">Intel i386 architecture specific definitions.</div></li><li><div class="item-name"><a class="struct" href="struct.X86_64.html" title="struct gimli::X86_64">X86_64</a></div><div class="desc docblock-short">AMD64 architecture specific definitions.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.DwarfFileType.html" title="enum gimli::DwarfFileType">DwarfFileType</a></div><div class="desc docblock-short">The “type” of file with DWARF debugging information. This determines, among other things,
which files DWARF sections should be loaded from.</div></li><li><div class="item-name"><a class="enum" href="enum.Format.html" title="enum gimli::Format">Format</a></div><div class="desc docblock-short">Whether the format of a compilation unit is 32- or 64-bit.</div></li><li><div class="item-name"><a class="enum" href="enum.RunTimeEndian.html" title="enum gimli::RunTimeEndian">RunTimeEndian</a></div><div class="desc docblock-short">Byte order that is selectable at runtime.</div></li><li><div class="item-name"><a class="enum" href="enum.SectionId.html" title="enum gimli::SectionId">SectionId</a></div><div class="desc docblock-short">An identifier for a DWARF section.</div></li><li><div class="item-name"><a class="enum" href="enum.UnitSectionOffset.html" title="enum gimli::UnitSectionOffset">UnitSectionOffset</a></div><div class="desc docblock-short">An offset into the <code>.debug_info</code> or <code>.debug_types</code> sections.</div></li><li><div class="item-name"><a class="enum" href="enum.Vendor.html" title="enum gimli::Vendor">Vendor</a></div><div class="desc docblock-short">Which vendor extensions to support.</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Endianity.html" title="trait gimli::Endianity">Endianity</a></div><div class="desc docblock-short">A trait describing the endianity of some buffer.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.NativeEndian.html" title="type gimli::NativeEndian">NativeEndian</a></div><div class="desc docblock-short">The native endianity for the target platform.</div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink