mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 16:38:24 +00:00
54 lines
20 KiB
HTML
54 lines
20 KiB
HTML
<!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="A trait for generic access to `pe::ImageNtHeaders32` and `pe::ImageNtHeaders64`."><title>ImageNtHeaders in 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 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></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="#">ImageNtHeaders</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.ImageOptionalHeader">ImageOptionalHeader</a></li><li><a href="#associatedtype.ImageThunkData">ImageThunkData</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.file_header">file_header</a></li><li><a href="#tymethod.is_type_64">is_type_64</a></li><li><a href="#tymethod.is_valid_optional_magic">is_valid_optional_magic</a></li><li><a href="#tymethod.optional_header">optional_header</a></li><li><a href="#tymethod.signature">signature</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.parse">parse</a></li><li><a href="#method.sections">sections</a></li><li><a href="#method.symbols">symbols</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In object::read::pe</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>Trait <a href="../../index.html">object</a>::<wbr><a href="../index.html">read</a>::<wbr><a href="index.html">pe</a>::<wbr><a class="trait" href="#">ImageNtHeaders</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/file.rs.html#566-648">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ImageNtHeaders: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="../../pod/trait.Pod.html" title="trait object::pod::Pod">Pod</a> {
|
||
type <a href="#associatedtype.ImageOptionalHeader" class="associatedtype">ImageOptionalHeader</a>: <a class="trait" href="trait.ImageOptionalHeader.html" title="trait object::read::pe::ImageOptionalHeader">ImageOptionalHeader</a>;
|
||
type <a href="#associatedtype.ImageThunkData" class="associatedtype">ImageThunkData</a>: <a class="trait" href="trait.ImageThunkData.html" title="trait object::read::pe::ImageThunkData">ImageThunkData</a>;
|
||
|
||
// Required methods
|
||
fn <a href="#tymethod.is_type_64" class="fn">is_type_64</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.is_valid_optional_magic" class="fn">is_valid_optional_magic</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.signature" class="fn">signature</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u32.html">u32</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.file_header" class="fn">file_header</a>(&self) -> &<a class="struct" href="../../pe/struct.ImageFileHeader.html" title="struct object::pe::ImageFileHeader">ImageFileHeader</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.optional_header" class="fn">optional_header</a>(&self) -> &Self::<a class="associatedtype" href="trait.ImageNtHeaders.html#associatedtype.ImageOptionalHeader" title="type object::read::pe::ImageNtHeaders::ImageOptionalHeader">ImageOptionalHeader</a>;
|
||
|
||
// Provided methods
|
||
fn <a href="#method.parse" class="fn">parse</a><'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>>(
|
||
data: R,
|
||
offset: &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>
|
||
) -> <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a><(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'data Self</a>, <a class="struct" href="struct.DataDirectories.html" title="struct object::read::pe::DataDirectories">DataDirectories</a><'data>)> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.sections" class="fn">sections</a><'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>>(
|
||
&self,
|
||
data: R,
|
||
offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>
|
||
) -> <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a><<a class="struct" href="../coff/struct.SectionTable.html" title="struct object::read::coff::SectionTable">SectionTable</a><'data>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.symbols" class="fn">symbols</a><'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>>(
|
||
&self,
|
||
data: R
|
||
) -> <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a><<a class="struct" href="../coff/struct.SymbolTable.html" title="struct object::read::coff::SymbolTable">SymbolTable</a><'data, R>> { ... }
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>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>.</p>
|
||
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><section id="associatedtype.ImageOptionalHeader" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#567">source</a><h4 class="code-header">type <a href="#associatedtype.ImageOptionalHeader" class="associatedtype">ImageOptionalHeader</a>: <a class="trait" href="trait.ImageOptionalHeader.html" title="trait object::read::pe::ImageOptionalHeader">ImageOptionalHeader</a></h4></section><section id="associatedtype.ImageThunkData" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#568">source</a><h4 class="code-header">type <a href="#associatedtype.ImageThunkData" class="associatedtype">ImageThunkData</a>: <a class="trait" href="trait.ImageThunkData.html" title="trait object::read::pe::ImageThunkData">ImageThunkData</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.is_type_64" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#573">source</a><h4 class="code-header">fn <a href="#tymethod.is_type_64" class="fn">is_type_64</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return true if this type is a 64-bit header.</p>
|
||
<p>This is a property of the type, not a value in the header data.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.is_valid_optional_magic" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#576">source</a><h4 class="code-header">fn <a href="#tymethod.is_valid_optional_magic" class="fn">is_valid_optional_magic</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return true if the magic field in the optional header is valid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.signature" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#579">source</a><h4 class="code-header">fn <a href="#tymethod.signature" class="fn">signature</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u32.html">u32</a></h4></section></summary><div class="docblock"><p>Return the signature</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.file_header" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#582">source</a><h4 class="code-header">fn <a href="#tymethod.file_header" class="fn">file_header</a>(&self) -> &<a class="struct" href="../../pe/struct.ImageFileHeader.html" title="struct object::pe::ImageFileHeader">ImageFileHeader</a></h4></section></summary><div class="docblock"><p>Return the file header.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.optional_header" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#585">source</a><h4 class="code-header">fn <a href="#tymethod.optional_header" class="fn">optional_header</a>(&self) -> &Self::<a class="associatedtype" href="trait.ImageNtHeaders.html#associatedtype.ImageOptionalHeader" title="type object::read::pe::ImageNtHeaders::ImageOptionalHeader">ImageOptionalHeader</a></h4></section></summary><div class="docblock"><p>Return the optional header.</p>
|
||
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.parse" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#597-626">source</a><h4 class="code-header">fn <a href="#method.parse" class="fn">parse</a><'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>>(
|
||
data: R,
|
||
offset: &mut <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>
|
||
) -> <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a><(<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.reference.html">&'data Self</a>, <a class="struct" href="struct.DataDirectories.html" title="struct object::read::pe::DataDirectories">DataDirectories</a><'data>)></h4></section></summary><div class="docblock"><p>Read the NT headers, including the data directories.</p>
|
||
<p><code>data</code> must be for the entire file.</p>
|
||
<p><code>offset</code> must be headers offset, which can be obtained from <a href="../../pe/struct.ImageDosHeader.html#method.nt_headers_offset" title="method object::pe::ImageDosHeader::nt_headers_offset"><code>pe::ImageDosHeader::nt_headers_offset</code></a>.
|
||
It is updated to point after the optional header, which is where the section headers are located.</p>
|
||
<p>Also checks that the <code>signature</code> and <code>magic</code> fields in the headers are valid.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.sections" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#633-639">source</a><h4 class="code-header">fn <a href="#method.sections" class="fn">sections</a><'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>>(
|
||
&self,
|
||
data: R,
|
||
offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>
|
||
) -> <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a><<a class="struct" href="../coff/struct.SectionTable.html" title="struct object::read::coff::SectionTable">SectionTable</a><'data>></h4></section></summary><div class="docblock"><p>Read the section table.</p>
|
||
<p><code>data</code> must be for the entire file.
|
||
<code>offset</code> must be after the optional file header.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.symbols" class="method"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#645-647">source</a><h4 class="code-header">fn <a href="#method.symbols" class="fn">symbols</a><'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>>(
|
||
&self,
|
||
data: R
|
||
) -> <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a><<a class="struct" href="../coff/struct.SymbolTable.html" title="struct object::read::coff::SymbolTable">SymbolTable</a><'data, R>></h4></section></summary><div class="docblock"><p>Read the COFF symbol table and string table.</p>
|
||
<p><code>data</code> must be the entire file data.</p>
|
||
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.76.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-ImageNtHeaders-for-ImageNtHeaders32" class="impl"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#688-716">source</a><a href="#impl-ImageNtHeaders-for-ImageNtHeaders32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ImageNtHeaders.html" title="trait object::read::pe::ImageNtHeaders">ImageNtHeaders</a> for <a class="struct" href="../../pe/struct.ImageNtHeaders32.html" title="struct object::pe::ImageNtHeaders32">ImageNtHeaders32</a></h3></section></summary><div class="impl-items"><section id="associatedtype.ImageOptionalHeader-1" class="associatedtype trait-impl"><a href="#associatedtype.ImageOptionalHeader-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.ImageOptionalHeader" class="associatedtype">ImageOptionalHeader</a> = <a class="struct" href="../../pe/struct.ImageOptionalHeader32.html" title="struct object::pe::ImageOptionalHeader32">ImageOptionalHeader32</a></h4></section><section id="associatedtype.ImageThunkData-1" class="associatedtype trait-impl"><a href="#associatedtype.ImageThunkData-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.ImageThunkData" class="associatedtype">ImageThunkData</a> = <a class="struct" href="../../pe/struct.ImageThunkData32.html" title="struct object::pe::ImageThunkData32">ImageThunkData32</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ImageNtHeaders-for-ImageNtHeaders64" class="impl"><a class="src rightside" href="../../../src/object/read/pe/file.rs.html#870-898">source</a><a href="#impl-ImageNtHeaders-for-ImageNtHeaders64" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ImageNtHeaders.html" title="trait object::read::pe::ImageNtHeaders">ImageNtHeaders</a> for <a class="struct" href="../../pe/struct.ImageNtHeaders64.html" title="struct object::pe::ImageNtHeaders64">ImageNtHeaders64</a></h3></section></summary><div class="impl-items"><section id="associatedtype.ImageOptionalHeader-2" class="associatedtype trait-impl"><a href="#associatedtype.ImageOptionalHeader-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.ImageOptionalHeader" class="associatedtype">ImageOptionalHeader</a> = <a class="struct" href="../../pe/struct.ImageOptionalHeader64.html" title="struct object::pe::ImageOptionalHeader64">ImageOptionalHeader64</a></h4></section><section id="associatedtype.ImageThunkData-2" class="associatedtype trait-impl"><a href="#associatedtype.ImageThunkData-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.ImageThunkData" class="associatedtype">ImageThunkData</a> = <a class="struct" href="../../pe/struct.ImageThunkData64.html" title="struct object::pe::ImageThunkData64">ImageThunkData64</a></h4></section></div></details></div><script src="../../../trait.impl/object/read/pe/file/trait.ImageNtHeaders.js" async></script></section></div></main></body></html> |