edlang/object/read/elf/trait.Sym.html
2024-03-02 09:26:34 +00:00

33 lines
20 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="A trait for generic access to `elf::Sym32` and `elf::Sym64`."><title>Sym in object::read::elf - 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">&#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="#">Sym</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.Endian">Endian</a></li><li><a href="#associatedtype.Word">Word</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.st_bind">st_bind</a></li><li><a href="#tymethod.st_info">st_info</a></li><li><a href="#tymethod.st_name">st_name</a></li><li><a href="#tymethod.st_other">st_other</a></li><li><a href="#tymethod.st_shndx">st_shndx</a></li><li><a href="#tymethod.st_size">st_size</a></li><li><a href="#tymethod.st_type">st_type</a></li><li><a href="#tymethod.st_value">st_value</a></li><li><a href="#tymethod.st_visibility">st_visibility</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.is_definition">is_definition</a></li><li><a href="#method.is_undefined">is_undefined</a></li><li><a href="#method.name">name</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::elf</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">elf</a>::<wbr><a class="trait" href="#">Sym</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/elf/symbol.rs.html#452-495">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><code>pub trait Sym: <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.Word" class="associatedtype">Word</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u64.html">u64</a>&gt;;
type <a href="#associatedtype.Endian" class="associatedtype">Endian</a>: <a class="trait" href="../../endian/trait.Endian.html" title="trait object::endian::Endian">Endian</a>;
// Required methods
fn <a href="#tymethod.st_name" class="fn">st_name</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_info" class="fn">st_info</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_bind" class="fn">st_bind</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_type" class="fn">st_type</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_other" class="fn">st_other</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_visibility" class="fn">st_visibility</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_shndx" class="fn">st_shndx</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u16.html">u16</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_value" class="fn">st_value</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Word" title="type object::read::elf::Sym::Word">Word</a>;
<span class="item-spacer"></span> fn <a href="#tymethod.st_size" class="fn">st_size</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Word" title="type object::read::elf::Sym::Word">Word</a>;
// Provided methods
fn <a href="#method.name" class="fn">name</a>&lt;'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a>&lt;'data&gt;&gt;(
&amp;self,
endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>,
strings: <a class="struct" href="../struct.StringTable.html" title="struct object::read::StringTable">StringTable</a>&lt;'data, R&gt;
) -&gt; <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a>&lt;&amp;'data [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]&gt; { ... }
<span class="item-spacer"></span> fn <a href="#method.is_undefined" class="fn">is_undefined</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a> { ... }
<span class="item-spacer"></span> fn <a href="#method.is_definition" class="fn">is_definition</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a> { ... }
}</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="../../elf/struct.Sym32.html" title="struct object::elf::Sym32"><code>elf::Sym32</code></a> and <a href="../../elf/struct.Sym64.html" title="struct object::elf::Sym64"><code>elf::Sym64</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.Word" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#453">source</a><h4 class="code-header">type <a href="#associatedtype.Word" class="associatedtype">Word</a>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u64.html">u64</a>&gt;</h4></section><section id="associatedtype.Endian" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#454">source</a><h4 class="code-header">type <a href="#associatedtype.Endian" class="associatedtype">Endian</a>: <a class="trait" href="../../endian/trait.Endian.html" title="trait object::endian::Endian">Endian</a></h4></section></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><section id="tymethod.st_name" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#456">source</a><h4 class="code-header">fn <a href="#tymethod.st_name" class="fn">st_name</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section><section id="tymethod.st_info" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#457">source</a><h4 class="code-header">fn <a href="#tymethod.st_info" class="fn">st_info</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a></h4></section><section id="tymethod.st_bind" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#458">source</a><h4 class="code-header">fn <a href="#tymethod.st_bind" class="fn">st_bind</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a></h4></section><section id="tymethod.st_type" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#459">source</a><h4 class="code-header">fn <a href="#tymethod.st_type" class="fn">st_type</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a></h4></section><section id="tymethod.st_other" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#460">source</a><h4 class="code-header">fn <a href="#tymethod.st_other" class="fn">st_other</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a></h4></section><section id="tymethod.st_visibility" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#461">source</a><h4 class="code-header">fn <a href="#tymethod.st_visibility" class="fn">st_visibility</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a></h4></section><section id="tymethod.st_shndx" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#462">source</a><h4 class="code-header">fn <a href="#tymethod.st_shndx" class="fn">st_shndx</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u16.html">u16</a></h4></section><section id="tymethod.st_value" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#463">source</a><h4 class="code-header">fn <a href="#tymethod.st_value" class="fn">st_value</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Word" title="type object::read::elf::Sym::Word">Word</a></h4></section><section id="tymethod.st_size" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#464">source</a><h4 class="code-header">fn <a href="#tymethod.st_size" class="fn">st_size</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Word" title="type object::read::elf::Sym::Word">Word</a></h4></section></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.name" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#467-475">source</a><h4 class="code-header">fn <a href="#method.name" class="fn">name</a>&lt;'data, R: <a class="trait" href="../trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a>&lt;'data&gt;&gt;(
&amp;self,
endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>,
strings: <a class="struct" href="../struct.StringTable.html" title="struct object::read::StringTable">StringTable</a>&lt;'data, R&gt;
) -&gt; <a class="type" href="../type.Result.html" title="type object::read::Result">Result</a>&lt;&amp;'data [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u8.html">u8</a>]&gt;</h4></section></summary><div class="docblock"><p>Parse the symbol name from the string table.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_undefined" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#479-481">source</a><h4 class="code-header">fn <a href="#method.is_undefined" class="fn">is_undefined</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return true if the symbol is undefined.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_definition" class="method"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#484-494">source</a><h4 class="code-header">fn <a href="#method.is_definition" class="fn">is_definition</a>(&amp;self, endian: Self::<a class="associatedtype" href="trait.Sym.html#associatedtype.Endian" title="type object::read::elf::Sym::Endian">Endian</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Return true if the symbol is a definition of a function or data object.</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-Sym-for-Sym32%3CEndian%3E" class="impl"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#497-545">source</a><a href="#impl-Sym-for-Sym32%3CEndian%3E" class="anchor">§</a><h3 class="code-header">impl&lt;Endian: <a class="trait" href="../../endian/trait.Endian.html" title="trait object::endian::Endian">Endian</a>&gt; <a class="trait" href="trait.Sym.html" title="trait object::read::elf::Sym">Sym</a> for <a class="struct" href="../../elf/struct.Sym32.html" title="struct object::elf::Sym32">Sym32</a>&lt;Endian&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Word-1" class="associatedtype trait-impl"><a href="#associatedtype.Word-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Word" class="associatedtype">Word</a> = <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u32.html">u32</a></h4></section><section id="associatedtype.Endian-1" class="associatedtype trait-impl"><a href="#associatedtype.Endian-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Endian" class="associatedtype">Endian</a> = Endian</h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Sym-for-Sym64%3CEndian%3E" class="impl"><a class="src rightside" href="../../../src/object/read/elf/symbol.rs.html#547-595">source</a><a href="#impl-Sym-for-Sym64%3CEndian%3E" class="anchor">§</a><h3 class="code-header">impl&lt;Endian: <a class="trait" href="../../endian/trait.Endian.html" title="trait object::endian::Endian">Endian</a>&gt; <a class="trait" href="trait.Sym.html" title="trait object::read::elf::Sym">Sym</a> for <a class="struct" href="../../elf/struct.Sym64.html" title="struct object::elf::Sym64">Sym64</a>&lt;Endian&gt;</h3></section></summary><div class="impl-items"><section id="associatedtype.Word-2" class="associatedtype trait-impl"><a href="#associatedtype.Word-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Word" class="associatedtype">Word</a> = <a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.u64.html">u64</a></h4></section><section id="associatedtype.Endian-2" class="associatedtype trait-impl"><a href="#associatedtype.Endian-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Endian" class="associatedtype">Endian</a> = Endian</h4></section></div></details></div><script src="../../../trait.impl/object/read/elf/symbol/trait.Sym.js" async></script></section></div></main></body></html>