<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A trait for generic access to `elf::FileHeader32` and `elf::FileHeader64`."><title>FileHeader in object::read::elf - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../../static.files/rustdoc-ac92e1bbe349e143.css"><metaname="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"><scriptsrc="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><scriptdefersrc="sidebar-items.js"></script><scriptdefersrc="../../../static.files/main-305769736d49e732.js"></script><noscript><linkrel="stylesheet"href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><linkrel="alternate icon"type="image/png"href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../../object/index.html">object</a><spanclass="version">0.32.2</span></h2></div><h2class="location"><ahref="#">FileHeader</a></h2><divclass="sidebar-elems"><section><h3><ahref="#required-associated-types">Required Associated Types</a></h3><ulclass="block"><li><ahref="#associatedtype.CompressionHeader">CompressionHeader</a></li><li><ahref="#associatedtype.Dyn">Dyn</a></li><li><ahref="#associatedtype.Endian">Endian</a></li><li><ahref="#associatedtype.NoteHeader">NoteHeader</a></li><li><ahref="#associatedtype.ProgramHeader">ProgramHeader</a></li><li><ahref="#associatedtype.Rel">Rel</a></li><li><ahref="#associatedtype.Rela">Rela</a></li><li><ahref="#associatedtype.SectionHeader">SectionHeader</a></li><li><ahref="#associatedtype.Sword">Sword</a></li><li><ahref="#associatedtype.Sym">Sym</a></li><li><ahref="#associatedtype.Word">Word</a></li></ul><h3><ahref="#required-methods">Required Methods</a></h3><ulclass="block"><li><ahref="#tymethod.e_ehsize">e_ehsize</a></li><li><ahref="#tymethod.e_entry">e_entry</a></li><li><ahref="#tymethod.e_flags">e_flags</a></li><li><ahref="#tymethod.e_ident">e_ident</a></li><li><ahref="#tymethod.e_machine">e_machine</a></li><li><ahref="#tymethod.e_phentsize">e_phentsize</a></li><li><ahref="#tymethod.e_phnum">e_phnum</a></li><li><ahref="#tymethod.e_phoff">e_phoff</a></li><li><ahref="#tymethod.e_shentsize">e_shentsize</a></li><li><ahref="#tymethod.e_shnum">e_shnum</a></li><li><ahref="#tymethod.e_shoff">e_shoff</a></li><li><ahref="#tymethod.e_shstrndx">e_shstrndx</a></li><li><ahref="#tymethod.e_type">e_type</a></li><li><ahref="#tymethod.e_version">e_version</a></li><li><ahref="#tymeth
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../../object/all.html"title="show sidebar"></a></div><inputclass="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"><divid="help-button"tabindex="-1"><ahref="../../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Trait <ahref="../../index.html">object</a>::<wbr><ahref="../index.html">read</a>::<wbr><ahref="index.html">elf</a>::<wbr><aclass="trait"href="#">FileHeader</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../../src/object/read/elf/file.rs.html#446-722">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><preclass="rust item-decl"><code>pub trait FileHeader: <aclass="trait"href="https://doc.rust-lang.org/1.76.0/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a> + <aclass="trait"href="../../pod/trait.Pod.html"title="trait object::pod::Pod">Pod</a> {
type <ahref="#associatedtype.Word"class="associatedtype">Word</a>: <aclass="trait"href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="primitive"href="https://doc.rust-lang.org/1.76.0/std/primitive.u64.html">u64</a>>;
type <ahref="#associatedtype.Sword"class="associatedtype">Sword</a>: <aclass="trait"href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><<aclass="primitive"href="https://doc.rust-lang.org/1.76.0/std/primitive.i64.html">i64</a>>;
type <ahref="#associatedtype.Endian"class="associatedtype">Endian</a>: <aclass="trait"href="../../endian/trait.Endian.html"title="trait object::endian::Endian">Endian</a>;
type <ahref="#associatedtype.ProgramHeader"class="associatedtype">ProgramHeader</a>: <aclass="trait"href="trait.ProgramHeader.html"title="trait object::read::elf::ProgramHeader">ProgramHeader</a><Elf = Self, Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>, Word = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Word"title="type object::read::elf::FileHeader::Word">Word</a>>;
type <ahref="#associatedtype.SectionHeader"class="associatedtype">SectionHeader</a>: <aclass="trait"href="trait.SectionHeader.html"title="trait object::read::elf::SectionHeader">SectionHeader</a><Elf = Self, Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>, Word = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Word"title="type object::read::elf::FileHeader::Word">Word</a>>;
type <ahref="#associatedtype.CompressionHeader"class="associatedtype">CompressionHeader</a>: <aclass="trait"href="trait.CompressionHeader.html"title="trait object::read::elf::CompressionHeader">CompressionHeader</a><Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>, Word = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Word"title="type object::read::elf::FileHeader::Word">Word</a>>;
type <ahref="#associatedtype.NoteHeader"class="associatedtype">NoteHeader</a>: <aclass="trait"href="trait.NoteHeader.html"title="trait object::read::elf::NoteHeader">NoteHeader</a><Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>>;
type <ahref="#associatedtype.Dyn"class="associatedtype">Dyn</a>: <aclass="trait"href="trait.Dyn.html"title="trait object::read::elf::Dyn">Dyn</a><Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>, Word = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Word"title="type object::read::elf::FileHeader::Word">Word</a>>;
type <ahref="#associatedtype.Sym"class="associatedtype">Sym</a>: <aclass="trait"href="trait.Sym.html"title="trait object::read::elf::Sym">Sym</a><Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>, Word = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Word"title="type object::read::elf::FileHeader::Word">Word</a>>;
type <ahref="#associatedtype.Rel"class="associatedtype">Rel</a>: <aclass="trait"href="trait.Rel.html"title="trait object::read::elf::Rel">Rel</a><Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>, Word = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Word"title="type object::read::elf::FileHeader::Word">Word</a>>;
type <ahref="#associatedtype.Rela"class="associatedtype">Rela</a>: <aclass="trait"href="trait.Rela.html"title="trait object::read::elf::Rela">Rela</a><Endian = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>, Word = Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Word"title="type object::read::elf::FileHeader::Word">Word</a>> + <aclass="trait"href="https://doc.rust-lang.org/1.76.0/core/convert/trait.From.html"title="trait core::convert::From">From</a><Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Rel"title="type object::read::elf::FileHeader::Rel">Rel</a>>;
</details>}</code></pre><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A trait for generic access to <ahref="../../elf/struct.FileHeader32.html"title="struct object::elf::FileHeader32"><code>elf::FileHeader32</code></a> and <ahref="../../elf/struct.FileHeader64.html"title="struct object::elf::FileHeader64"><code>elf::FileHeader64</code></a>.</p>
Self: <aclass="trait"href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html"title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><divclass="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>
<p>This is the same as <ahref="trait.FileHeader.html#tymethod.is_type_64"><code>Self::is_type_64</code></a>, but is non-dispatchable.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.is_supported"class="method"><aclass="src rightside"href="../../../src/object/read/elf/file.rs.html#508-516">source</a><h4class="code-header">fn <ahref="#method.is_supported"class="fn">is_supported</a>(&self) -><aclass="primitive"href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Check that the ident field in the file header is a supported format.</p>
) -><aclass="type"href="../type.Result.html"title="type object::read::Result">Result</a><<aclass="enum"href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><&'data Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.SectionHeader"title="type object::read::elf::FileHeader::SectionHeader">SectionHeader</a>>></h4></section></summary><divclass="docblock"><p>Return the first section header, if present.</p>
<p>Section 0 is a special case because getting the section headers normally
requires <code>shnum</code>, but <code>shnum</code> may be in the first section header.</p>
) -><aclass="type"href="../type.Result.html"title="type object::read::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>></h4></section></summary><divclass="docblock"><p>Return the <code>e_phnum</code> field of the header. Handles extended values.</p>
) -><aclass="type"href="../type.Result.html"title="type object::read::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.76.0/std/primitive.usize.html">usize</a>></h4></section></summary><divclass="docblock"><p>Return the <code>e_shnum</code> field of the header. Handles extended values.</p>
) -><aclass="type"href="../type.Result.html"title="type object::read::Result">Result</a><<aclass="primitive"href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>></h4></section></summary><divclass="docblock"><p>Return the <code>e_shstrndx</code> field of the header. Handles extended values.</p>
) -><aclass="type"href="../type.Result.html"title="type object::read::Result">Result</a><&'data [Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.ProgramHeader"title="type object::read::elf::FileHeader::ProgramHeader">ProgramHeader</a>]></h4></section></summary><divclass="docblock"><p>Return the slice of program headers.</p>
<p>Returns <code>Ok(&[])</code> if there are no program headers.
) -><aclass="type"href="../type.Result.html"title="type object::read::Result">Result</a><&'data [Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.SectionHeader"title="type object::read::elf::FileHeader::SectionHeader">SectionHeader</a>]></h4></section></summary><divclass="docblock"><p>Return the slice of section headers.</p>
<p>Returns <code>Ok(&[])</code> if there are no section headers.
) -><aclass="type"href="../type.Result.html"title="type object::read::Result">Result</a><<aclass="struct"href="../struct.StringTable.html"title="struct object::read::StringTable">StringTable</a><'data, R>></h4></section></summary><divclass="docblock"><p>Return the string table for the section headers.</p>
</div></details><detailsclass="toggle method-toggle"open><summary><sectionid="method.is_mips64el"class="method"><aclass="src rightside"href="../../../src/object/read/elf/file.rs.html#719-721">source</a><h4class="code-header">fn <ahref="#method.is_mips64el"class="fn">is_mips64el</a>(&self, endian: Self::<aclass="associatedtype"href="trait.FileHeader.html#associatedtype.Endian"title="type object::read::elf::FileHeader::Endian">Endian</a>) -><aclass="primitive"href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><divclass="docblock"><p>Returns whether this is a mips64el elf file.</p>
