mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
20 lines
16 KiB
HTML
20 lines
16 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 symbol table in an `Object`."><title>ObjectSymbolTable in object::read - 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="#">ObjectSymbolTable</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.Symbol">Symbol</a></li><li><a href="#associatedtype.SymbolIterator">SymbolIterator</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.symbol_by_index">symbol_by_index</a></li><li><a href="#tymethod.symbols">symbols</a></li></ul><h3><a href="#implementors">Implementors</a></h3></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>Trait <a href="../index.html">object</a>::<wbr><a href="index.html">read</a>::<wbr><a class="trait" href="#">ObjectSymbolTable</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/traits.rs.html#454-472">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ObjectSymbolTable<'data>: Sealed {
|
|||
|
|
type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a>: <a class="trait" href="trait.ObjectSymbol.html" title="trait object::read::ObjectSymbol">ObjectSymbol</a><'data>;
|
|||
|
|
type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>>;
|
|||
|
|
|
|||
|
|
// Required methods
|
|||
|
|
fn <a href="#tymethod.symbols" class="fn">symbols</a>(&self) -> Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.SymbolIterator" title="type object::read::ObjectSymbolTable::SymbolIterator">SymbolIterator</a>;
|
|||
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.symbol_by_index" class="fn">symbol_by_index</a>(&self, index: <a class="struct" href="struct.SymbolIndex.html" title="struct object::read::SymbolIndex">SymbolIndex</a>) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>>;
|
|||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A symbol table in an <a href="trait.Object.html" title="trait object::read::Object"><code>Object</code></a>.</p>
|
|||
|
|
<p>This trait is part of the unified read API.</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"><details class="toggle" open><summary><section id="associatedtype.Symbol" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#456">source</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a>: <a class="trait" href="trait.ObjectSymbol.html" title="trait object::read::ObjectSymbol">ObjectSymbol</a><'data></h4></section></summary><div class="docblock"><p>A symbol table entry.</p>
|
|||
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.SymbolIterator" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#459">source</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a><Item = Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>></h4></section></summary><div class="docblock"><p>An iterator for the symbols in a symbol table.</p>
|
|||
|
|
</div></details></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.symbols" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#464">source</a><h4 class="code-header">fn <a href="#tymethod.symbols" class="fn">symbols</a>(&self) -> Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.SymbolIterator" title="type object::read::ObjectSymbolTable::SymbolIterator">SymbolIterator</a></h4></section></summary><div class="docblock"><p>Get an iterator for the symbols in the table.</p>
|
|||
|
|
<p>This may skip over symbols that are malformed or unsupported.</p>
|
|||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.symbol_by_index" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#471">source</a><h4 class="code-header">fn <a href="#tymethod.symbol_by_index" class="fn">symbol_by_index</a>(&self, index: <a class="struct" href="struct.SymbolIndex.html" title="struct object::read::SymbolIndex">SymbolIndex</a>) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><Self::<a class="associatedtype" href="trait.ObjectSymbolTable.html#associatedtype.Symbol" title="type object::read::ObjectSymbolTable::Symbol">Symbol</a>></h4></section></summary><div class="docblock"><p>Get the symbol at the given index.</p>
|
|||
|
|
<p>The meaning of the index depends on the object file.</p>
|
|||
|
|
<p>Returns an error if the index is invalid.</p>
|
|||
|
|
</div></details></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-ObjectSymbolTable%3C'data%3E-for-ElfSymbolTable%3C'data,+'file,+Elf,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/elf/symbol.rs.html#225-248">source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-ElfSymbolTable%3C'data,+'file,+Elf,+R%3E" class="anchor">§</a><h3 class="code-header">impl<'data, 'file, Elf: <a class="trait" href="elf/trait.FileHeader.html" title="trait object::read::elf::FileHeader">FileHeader</a>, R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>> <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a><'data> for <a class="struct" href="elf/struct.ElfSymbolTable.html" title="struct object::read::elf::ElfSymbolTable">ElfSymbolTable</a><'data, 'file, Elf, R></h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-1" class="associatedtype trait-impl"><a href="#associatedtype.Symbol-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="elf/struct.ElfSymbol.html" title="struct object::read::elf::ElfSymbol">ElfSymbol</a><'data, 'file, Elf, R></h4></section><section id="associatedtype.SymbolIterator-1" class="associatedtype trait-impl"><a href="#associatedtype.SymbolIterator-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="elf/struct.ElfSymbolIterator.html" title="struct object::read::elf::ElfSymbolIterator">ElfSymbolIterator</a><'data, 'file, Elf, R></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-MachOSymbolTable%3C'data,+'file,+Mach,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/macho/symbol.rs.html#172-191">source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-MachOSymbolTable%3C'data,+'file,+Mach,+R%3E" class="anchor">§</a><h3 class="code-header">impl<'data, 'file, Mach, R> <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a><'data> for <a class="struct" href="macho/struct.MachOSymbolTable.html" title="struct object::read::macho::MachOSymbolTable">MachOSymbolTable</a><'data, 'file, Mach, R><div class="where">where
|
|||
|
|
Mach: <a class="trait" href="macho/trait.MachHeader.html" title="trait object::read::macho::MachHeader">MachHeader</a>,
|
|||
|
|
R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-2" class="associatedtype trait-impl"><a href="#associatedtype.Symbol-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="macho/struct.MachOSymbol.html" title="struct object::read::macho::MachOSymbol">MachOSymbol</a><'data, 'file, Mach, R></h4></section><section id="associatedtype.SymbolIterator-2" class="associatedtype trait-impl"><a href="#associatedtype.SymbolIterator-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="macho/struct.MachOSymbolIterator.html" title="struct object::read::macho::MachOSymbolIterator">MachOSymbolIterator</a><'data, 'file, Mach, R></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-SymbolTable%3C'data,+'file,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/any.rs.html#1013-1035">source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-SymbolTable%3C'data,+'file,+R%3E" class="anchor">§</a><h3 class="code-header">impl<'data, 'file, R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>> <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a><'data> for <a class="struct" href="struct.SymbolTable.html" title="struct object::read::SymbolTable">SymbolTable</a><'data, 'file, R></h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-3" class="associatedtype trait-impl"><a href="#associatedtype.Symbol-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="struct.Symbol.html" title="struct object::read::Symbol">Symbol</a><'data, 'file, R></h4></section><section id="associatedtype.SymbolIterator-3" class="associatedtype trait-impl"><a href="#associatedtype.SymbolIterator-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.SymbolIterator" class="associatedtype">SymbolIterator</a> = <a class="struct" href="struct.SymbolIterator.html" title="struct object::read::SymbolIterator">SymbolIterator</a><'data, 'file, R></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ObjectSymbolTable%3C'data%3E-for-CoffSymbolTable%3C'data,+'file,+R,+Coff%3E" class="impl"><a class="src rightside" href="../../src/object/read/coff/symbol.rs.html#213-234">source</a><a href="#impl-ObjectSymbolTable%3C'data%3E-for-CoffSymbolTable%3C'data,+'file,+R,+Coff%3E" class="anchor">§</a><h3 class="code-header">impl<'data, 'file, R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>, Coff: <a class="trait" href="coff/trait.CoffHeader.html" title="trait object::read::coff::CoffHeader">CoffHeader</a>> <a class="trait" href="trait.ObjectSymbolTable.html" title="trait object::read::ObjectSymbolTable">ObjectSymbolTable</a><'data> for <a class="struct" href="coff/struct.CoffSymbolTable.html" title="struct object::read::coff::CoffSymbolTable">CoffSymbolTable</a><'data, 'file, R, Coff></h3></section></summary><div class="impl-items"><section id="associatedtype.Symbol-4" class="associatedtype trait-impl"><a href="#associatedtype.Symbol-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Symbol" class="associatedtype">Symbol</a> = <a class="struct" href="coff/struct.CoffSymbol.html" title="struct object::read::coff::CoffSymbol">CoffSymbol</a><'data, 'file, R, Coff></h4></section><section id="associatedtype.SymbolIterator-4" class="associatedtype trait-impl"><a href="#associatedtype.SymbolIterator-4
|