mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-10 10:08:23 +00:00
34 lines
18 KiB
HTML
34 lines
18 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 loadable segment in an `Object`."><title>ObjectSegment 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="#">ObjectSegment</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.address">address</a></li><li><a href="#tymethod.align">align</a></li><li><a href="#tymethod.data">data</a></li><li><a href="#tymethod.data_range">data_range</a></li><li><a href="#tymethod.file_range">file_range</a></li><li><a href="#tymethod.flags">flags</a></li><li><a href="#tymethod.name">name</a></li><li><a href="#tymethod.name_bytes">name_bytes</a></li><li><a href="#tymethod.size">size</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="#">ObjectSegment</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#305-339">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait ObjectSegment<'data>: Sealed {
|
||
// Required methods
|
||
fn <a href="#tymethod.address" class="fn">address</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.size" class="fn">size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.align" class="fn">align</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.file_range" class="fn">file_range</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.data" class="fn">data</a>(&self) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><&'data [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.data_range" class="fn">data_range</a>(&self, address: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>, size: <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="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'data [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.name_bytes" class="fn">name_bytes</a>(&self) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.name" class="fn">name</a>(&self) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.str.html">str</a>>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.flags" class="fn">flags</a>(&self) -> <a class="enum" href="../enum.SegmentFlags.html" title="enum object::SegmentFlags">SegmentFlags</a>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A loadable segment 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-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.address" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#307">source</a><h4 class="code-header">fn <a href="#tymethod.address" class="fn">address</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a></h4></section></summary><div class="docblock"><p>Returns the virtual address of the segment.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.size" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#310">source</a><h4 class="code-header">fn <a href="#tymethod.size" class="fn">size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a></h4></section></summary><div class="docblock"><p>Returns the size of the segment in memory.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.align" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#313">source</a><h4 class="code-header">fn <a href="#tymethod.align" class="fn">align</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a></h4></section></summary><div class="docblock"><p>Returns the alignment of the segment in memory.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.file_range" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#316">source</a><h4 class="code-header">fn <a href="#tymethod.file_range" class="fn">file_range</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>)</h4></section></summary><div class="docblock"><p>Returns the offset and size of the segment in the file.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.data" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#322">source</a><h4 class="code-header">fn <a href="#tymethod.data" class="fn">data</a>(&self) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><&'data [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]></h4></section></summary><div class="docblock"><p>Returns a reference to the file contents of the segment.</p>
|
||
<p>The length of this data may be different from the size of the
|
||
segment in memory.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.data_range" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#327">source</a><h4 class="code-header">fn <a href="#tymethod.data_range" class="fn">data_range</a>(&self, address: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>, size: <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="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'data [<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]>></h4></section></summary><div class="docblock"><p>Return the segment data in the given range.</p>
|
||
<p>Returns <code>Ok(None)</code> if the segment does not contain the given range.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.name_bytes" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#330">source</a><h4 class="code-header">fn <a href="#tymethod.name_bytes" class="fn">name_bytes</a>(&self) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&[<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>]>></h4></section></summary><div class="docblock"><p>Returns the name of the segment.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.name" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#335">source</a><h4 class="code-header">fn <a href="#tymethod.name" class="fn">name</a>(&self) -> <a class="type" href="type.Result.html" title="type object::read::Result">Result</a><<a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.str.html">str</a>>></h4></section></summary><div class="docblock"><p>Returns the name of the segment.</p>
|
||
<p>Returns an error if the name is not UTF-8.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.flags" class="method"><a class="src rightside" href="../../src/object/read/traits.rs.html#338">source</a><h4 class="code-header">fn <a href="#tymethod.flags" class="fn">flags</a>(&self) -> <a class="enum" href="../enum.SegmentFlags.html" title="enum object::SegmentFlags">SegmentFlags</a></h4></section></summary><div class="docblock"><p>Return the flags of segment.</p>
|
||
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-ObjectSegment%3C'data%3E-for-ElfSegment%3C'data,+'file,+Elf,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/elf/segment.rs.html#84-138">source</a><a href="#impl-ObjectSegment%3C'data%3E-for-ElfSegment%3C'data,+'file,+Elf,+R%3E" class="anchor">§</a><h3 class="code-header">impl<'data, 'file, Elf, R> <a class="trait" href="trait.ObjectSegment.html" title="trait object::read::ObjectSegment">ObjectSegment</a><'data> for <a class="struct" href="elf/struct.ElfSegment.html" title="struct object::read::elf::ElfSegment">ElfSegment</a><'data, 'file, Elf, R><div class="where">where
|
||
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>,</div></h3></section><section id="impl-ObjectSegment%3C'data%3E-for-MachOSegment%3C'data,+'file,+Mach,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/macho/segment.rs.html#84-148">source</a><a href="#impl-ObjectSegment%3C'data%3E-for-MachOSegment%3C'data,+'file,+Mach,+R%3E" class="anchor">§</a><h3 class="code-header">impl<'data, 'file, Mach, R> <a class="trait" href="trait.ObjectSegment.html" title="trait object::read::ObjectSegment">ObjectSegment</a><'data> for <a class="struct" href="macho/struct.MachOSegment.html" title="struct object::read::macho::MachOSegment">MachOSegment</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><section id="impl-ObjectSegment%3C'data%3E-for-PeSegment%3C'data,+'file,+Pe,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/pe/section.rs.html#74-135">source</a><a href="#impl-ObjectSegment%3C'data%3E-for-PeSegment%3C'data,+'file,+Pe,+R%3E" class="anchor">§</a><h3 class="code-header">impl<'data, 'file, Pe, R> <a class="trait" href="trait.ObjectSegment.html" title="trait object::read::ObjectSegment">ObjectSegment</a><'data> for <a class="struct" href="pe/struct.PeSegment.html" title="struct object::read::pe::PeSegment">PeSegment</a><'data, 'file, Pe, R><div class="where">where
|
||
Pe: <a class="trait" href="pe/trait.ImageNtHeaders.html" title="trait object::read::pe::ImageNtHeaders">ImageNtHeaders</a>,
|
||
R: <a class="trait" href="trait.ReadRef.html" title="trait object::read::ReadRef">ReadRef</a><'data>,</div></h3></section><section id="impl-ObjectSegment%3C'data%3E-for-Segment%3C'data,+'file,+R%3E" class="impl"><a class="src rightside" href="../../src/object/read/any.rs.html#583-619">source</a><a href="#impl-ObjectSegment%3C'data%3E-for-Segment%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.ObjectSegment.html" title="trait object::read::ObjectSegment">ObjectSegment</a><'data> for <a class="struct" href="struct.Segment.html" title="struct object::read::Segment">Segment</a><'data, 'file, R></h3></section><section id="impl-ObjectSegment%3C'data%3E-for-CoffSegment%3C'data,+'file,+R,+Coff%3E" class="impl"><a class="src rightside" href="../../src/object/read/coff/section.rs.html#172-230">source</a><a href="#impl-ObjectSegment%3C'data%3E-for-CoffSegment%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.ObjectSegment.html" title="trait object::read::ObjectSegment">ObjectSegment</a><'data> for <a class="struct" href="coff/struct.CoffSegment.html" title="struct object::read::coff::CoffSegment">CoffSegment</a><'data, 'file, R, Coff></h3></section></div><script src="../../trait.impl/object/read/traits/trait.ObjectSegment.js" async></script></section></div></main></body></html> |