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

32 lines
23 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="Support for reading PE files."><title>object::read::pe - 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="object" 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="../../../object/index.html">object</a><span class="version">0.32.2</span></h2></div><h2 class="location"><a href="#">Module pe</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</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="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In object::read</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="../../../object/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">object</a>::<wbr><a href="../index.html">read</a>::<wbr><a class="mod" href="#">pe</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/object/read/pe/mod.rs.html#1-68">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>Support for reading PE files.</p>
<p>Traits are used to abstract over the difference between PE32 and PE32+.
The primary trait for this is <a href="trait.ImageNtHeaders.html" title="trait object::read::pe::ImageNtHeaders"><code>ImageNtHeaders</code></a>.</p>
<h3 id="high-level-api"><a href="#high-level-api">High level API</a></h3>
<p><a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a> implements the <a href="../trait.Object.html" title="trait object::read::Object"><code>Object</code></a> trait for
PE files. <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a> is parameterised by <a href="trait.ImageNtHeaders.html" title="trait object::read::pe::ImageNtHeaders"><code>ImageNtHeaders</code></a> to allow
reading both PE32 and PE32+. There are type aliases for these parameters
(<a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a> and <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>).</p>
<h3 id="low-level-api"><a href="#low-level-api">Low level API</a></h3>
<p>The <a href="trait.ImageNtHeaders.html" title="trait object::read::pe::ImageNtHeaders"><code>ImageNtHeaders</code></a> trait can be directly used to parse both
<a href="../../pe/struct.ImageNtHeaders32.html" title="struct object::pe::ImageNtHeaders32"><code>pe::ImageNtHeaders32</code></a> and <a href="../../pe/struct.ImageNtHeaders64.html" title="struct object::pe::ImageNtHeaders64"><code>pe::ImageNtHeaders64</code></a>.</p>
<h4 id="example-for-low-level-api"><a href="#example-for-low-level-api">Example for low level API</a></h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>object::pe;
<span class="kw">use </span>object::read::pe::ImageNtHeaders;
<span class="kw">use </span>std::error::Error;
<span class="kw">use </span>std::fs;
<span class="doccomment">/// Reads a file and displays the name of each section.
</span><span class="kw">fn </span>main() -&gt; <span class="prelude-ty">Result</span>&lt;(), Box&lt;<span class="kw">dyn </span>Error&gt;&gt; {
<span class="kw">let </span>data = fs::read(<span class="string">"path/to/binary"</span>)<span class="question-mark">?</span>;
<span class="kw">let </span>dos_header = pe::ImageDosHeader::parse(<span class="kw-2">&amp;*</span>data)<span class="question-mark">?</span>;
<span class="kw">let </span><span class="kw-2">mut </span>offset = dos_header.nt_headers_offset().into();
<span class="kw">let </span>(nt_headers, data_directories) = pe::ImageNtHeaders64::parse(<span class="kw-2">&amp;*</span>data, <span class="kw-2">&amp;mut </span>offset)<span class="question-mark">?</span>;
<span class="kw">let </span>sections = nt_headers.sections(<span class="kw-2">&amp;*</span>data, offset)<span class="question-mark">?</span>;
<span class="kw">let </span>symbols = nt_headers.symbols(<span class="kw-2">&amp;*</span>data)<span class="question-mark">?</span>;
<span class="kw">for </span>section <span class="kw">in </span>sections.iter() {
<span class="macro">println!</span>(<span class="string">"{}"</span>, String::from_utf8_lossy(section.name(symbols.strings())<span class="question-mark">?</span>));
}
<span class="prelude-val">Ok</span>(())
}</code></pre></div>
</div></details><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.SectionTable"><code>pub use super::coff::<a class="struct" href="../coff/struct.SectionTable.html" title="struct object::read::coff::SectionTable">SectionTable</a>;</code></div></li><li><div class="item-name" id="reexport.SymbolTable"><code>pub use super::coff::<a class="struct" href="../coff/struct.SymbolTable.html" title="struct object::read::coff::SymbolTable">SymbolTable</a>;</code></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.DataDirectories.html" title="struct object::read::pe::DataDirectories">DataDirectories</a></div><div class="desc docblock-short">The table of data directories in a PE file.</div></li><li><div class="item-name"><a class="struct" href="struct.DelayLoadDescriptorIterator.html" title="struct object::read::pe::DelayLoadDescriptorIterator">DelayLoadDescriptorIterator</a></div><div class="desc docblock-short">A fallible iterator for the descriptors in the delay-load data directory.</div></li><li><div class="item-name"><a class="struct" href="struct.DelayLoadImportTable.html" title="struct object::read::pe::DelayLoadImportTable">DelayLoadImportTable</a></div><div class="desc docblock-short">Information for parsing a PE delay-load import table.</div></li><li><div class="item-name"><a class="struct" href="struct.Export.html" title="struct object::read::pe::Export">Export</a></div><div class="desc docblock-short">An export from a PE file.</div></li><li><div class="item-name"><a class="struct" href="struct.ExportTable.html" title="struct object::read::pe::ExportTable">ExportTable</a></div><div class="desc docblock-short">A partially parsed PE export table.</div></li><li><div class="item-name"><a class="struct" href="struct.ImportDescriptorIterator.html" title="struct object::read::pe::ImportDescriptorIterator">ImportDescriptorIterator</a></div><div class="desc docblock-short">A fallible iterator for the descriptors in the import data directory.</div></li><li><div class="item-name"><a class="struct" href="struct.ImportTable.html" title="struct object::read::pe::ImportTable">ImportTable</a></div><div class="desc docblock-short">Information for parsing a PE import table.</div></li><li><div class="item-name"><a class="struct" href="struct.ImportThunkList.html" title="struct object::read::pe::ImportThunkList">ImportThunkList</a></div><div class="desc docblock-short">A list of import thunks.</div></li><li><div class="item-name"><a class="struct" href="struct.PeComdat.html" title="struct object::read::pe::PeComdat">PeComdat</a></div><div class="desc docblock-short">A COMDAT section group in a <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PeComdatIterator.html" title="struct object::read::pe::PeComdatIterator">PeComdatIterator</a></div><div class="desc docblock-short">An iterator for the COMDAT section groups in a <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PeComdatSectionIterator.html" title="struct object::read::pe::PeComdatSectionIterator">PeComdatSectionIterator</a></div><div class="desc docblock-short">An iterator for the sections in a COMDAT section group in a <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PeFile.html" title="struct object::read::pe::PeFile">PeFile</a></div><div class="desc docblock-short">A PE image file.</div></li><li><div class="item-name"><a class="struct" href="struct.PeRelocationIterator.html" title="struct object::read::pe::PeRelocationIterator">PeRelocationIterator</a></div><div class="desc docblock-short">An iterator for the relocations in an <a href="struct.PeSection.html" title="struct object::read::pe::PeSection"><code>PeSection</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PeSection.html" title="struct object::read::pe::PeSection">PeSection</a></div><div class="desc docblock-short">A section in a <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PeSectionIterator.html" title="struct object::read::pe::PeSectionIterator">PeSectionIterator</a></div><div class="desc docblock-short">An iterator for the sections in a <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PeSegment.html" title="struct object::read::pe::PeSegment">PeSegment</a></div><div class="desc docblock-short">A loadable section in a <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.PeSegmentIterator.html" title="struct object::read::pe::PeSegmentIterator">PeSegmentIterator</a></div><div class="desc docblock-short">An iterator for the loadable sections in a <a href="struct.PeFile.html" title="struct object::read::pe::PeFile"><code>PeFile</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.Relocation.html" title="struct object::read::pe::Relocation">Relocation</a></div><div class="desc docblock-short">A relocation in the <code>.reloc</code> section of a PE file.</div></li><li><div class="item-name"><a class="struct" href="struct.RelocationBlockIterator.html" title="struct object::read::pe::RelocationBlockIterator">RelocationBlockIterator</a></div><div class="desc docblock-short">An iterator over the relocation blocks in the <code>.reloc</code> section of a PE file.</div></li><li><div class="item-name"><a class="struct" href="struct.RelocationIterator.html" title="struct object::read::pe::RelocationIterator">RelocationIterator</a></div><div class="desc docblock-short">An iterator of the relocations in a block in the <code>.reloc</code> section of a PE file.</div></li><li><div class="item-name"><a class="struct" href="struct.ResourceDirectory.html" title="struct object::read::pe::ResourceDirectory">ResourceDirectory</a></div><div class="desc docblock-short">The <code>.rsrc</code> section of a PE file.</div></li><li><div class="item-name"><a class="struct" href="struct.ResourceDirectoryTable.html" title="struct object::read::pe::ResourceDirectoryTable">ResourceDirectoryTable</a></div><div class="desc docblock-short">A table of resource entries.</div></li><li><div class="item-name"><a class="struct" href="struct.ResourceName.html" title="struct object::read::pe::ResourceName">ResourceName</a></div><div class="desc docblock-short">A resource name.</div></li><li><div class="item-name"><a class="struct" href="struct.RichHeaderEntry.html" title="struct object::read::pe::RichHeaderEntry">RichHeaderEntry</a></div><div class="desc docblock-short">A PE rich header entry after it has been unmasked.</div></li><li><div class="item-name"><a class="struct" href="struct.RichHeaderInfo.html" title="struct object::read::pe::RichHeaderInfo">RichHeaderInfo</a></div><div class="desc docblock-short">Parsed information about a Rich Header.</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.ExportTarget.html" title="enum object::read::pe::ExportTarget">ExportTarget</a></div><div class="desc docblock-short">Where an export is pointing to.</div></li><li><div class="item-name"><a class="enum" href="enum.Import.html" title="enum object::read::pe::Import">Import</a></div><div class="desc docblock-short">A parsed import thunk.</div></li><li><div class="item-name"><a class="enum" href="enum.ResourceDirectoryEntryData.html" title="enum object::read::pe::ResourceDirectoryEntryData">ResourceDirectoryEntryData</a></div><div class="desc docblock-short">Data associated with a resource directory entry.</div></li><li><div class="item-name"><a class="enum" href="enum.ResourceNameOrId.html" title="enum object::read::pe::ResourceNameOrId">ResourceNameOrId</a></div><div class="desc docblock-short">A resource name or ID.</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.ImageNtHeaders.html" title="trait object::read::pe::ImageNtHeaders">ImageNtHeaders</a></div><div class="desc docblock-short">A trait for generic access to <a href="../../pe/struct.ImageNtHeaders32.html" title="struct object::pe::ImageNtHeaders32"><code>pe::ImageNtHeaders32</code></a> and <a href="../../pe/struct.ImageNtHeaders64.html" title="struct object::pe::ImageNtHeaders64"><code>pe::ImageNtHeaders64</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.ImageOptionalHeader.html" title="trait object::read::pe::ImageOptionalHeader">ImageOptionalHeader</a></div><div class="desc docblock-short">A trait for generic access to <a href="../../pe/struct.ImageOptionalHeader32.html" title="struct object::pe::ImageOptionalHeader32"><code>pe::ImageOptionalHeader32</code></a> and <a href="../../pe/struct.ImageOptionalHeader64.html" title="struct object::pe::ImageOptionalHeader64"><code>pe::ImageOptionalHeader64</code></a>.</div></li><li><div class="item-name"><a class="trait" href="trait.ImageThunkData.html" title="trait object::read::pe::ImageThunkData">ImageThunkData</a></div><div class="desc docblock-short">A trait for generic access to <a href="../../pe/struct.ImageThunkData32.html" title="struct object::pe::ImageThunkData32"><code>pe::ImageThunkData32</code></a> and <a href="../../pe/struct.ImageThunkData64.html" title="struct object::pe::ImageThunkData64"><code>pe::ImageThunkData64</code></a>.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.optional_header_magic.html" title="fn object::read::pe::optional_header_magic">optional_header_magic</a></div><div class="desc docblock-short">Find the optional header and read its <code>magic</code> field.</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.PeComdat32.html" title="type object::read::pe::PeComdat32">PeComdat32</a></div><div class="desc docblock-short">A COMDAT section group in a <a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeComdat64.html" title="type object::read::pe::PeComdat64">PeComdat64</a></div><div class="desc docblock-short">A COMDAT section group in a <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeComdatIterator32.html" title="type object::read::pe::PeComdatIterator32">PeComdatIterator32</a></div><div class="desc docblock-short">An iterator for the COMDAT section groups in a <a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeComdatIterator64.html" title="type object::read::pe::PeComdatIterator64">PeComdatIterator64</a></div><div class="desc docblock-short">An iterator for the COMDAT section groups in a <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeComdatSectionIterator32.html" title="type object::read::pe::PeComdatSectionIterator32">PeComdatSectionIterator32</a></div><div class="desc docblock-short">An iterator for the sections in a COMDAT section group in a <a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeComdatSectionIterator64.html" title="type object::read::pe::PeComdatSectionIterator64">PeComdatSectionIterator64</a></div><div class="desc docblock-short">An iterator for the sections in a COMDAT section group in a <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeFile32.html" title="type object::read::pe::PeFile32">PeFile32</a></div><div class="desc docblock-short">A PE32 (32-bit) image file.</div></li><li><div class="item-name"><a class="type" href="type.PeFile64.html" title="type object::read::pe::PeFile64">PeFile64</a></div><div class="desc docblock-short">A PE32+ (64-bit) image file.</div></li><li><div class="item-name"><a class="type" href="type.PeSection32.html" title="type object::read::pe::PeSection32">PeSection32</a></div><div class="desc docblock-short">A section in a <a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeSection64.html" title="type object::read::pe::PeSection64">PeSection64</a></div><div class="desc docblock-short">A section in a <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeSectionIterator32.html" title="type object::read::pe::PeSectionIterator32">PeSectionIterator32</a></div><div class="desc docblock-short">An iterator for the sections in a <a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeSectionIterator64.html" title="type object::read::pe::PeSectionIterator64">PeSectionIterator64</a></div><div class="desc docblock-short">An iterator for the sections in a <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeSegment32.html" title="type object::read::pe::PeSegment32">PeSegment32</a></div><div class="desc docblock-short">A loadable section in a <a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeSegment64.html" title="type object::read::pe::PeSegment64">PeSegment64</a></div><div class="desc docblock-short">A loadable section in a <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeSegmentIterator32.html" title="type object::read::pe::PeSegmentIterator32">PeSegmentIterator32</a></div><div class="desc docblock-short">An iterator for the loadable sections in a <a href="type.PeFile32.html" title="type object::read::pe::PeFile32"><code>PeFile32</code></a>.</div></li><li><div class="item-name"><a class="type" href="type.PeSegmentIterator64.html" title="type object::read::pe::PeSegmentIterator64">PeSegmentIterator64</a></div><div class="desc docblock-short">An iterator for the loadable sections in a <a href="type.PeFile64.html" title="type object::read::pe::PeFile64"><code>PeFile64</code></a>.</div></li></ul></section></div></main></body></html>
Reference in a new issue View git blame Copy permalink