edlang/gimli/read/trait.ReaderOffset.html

23 lines
24 KiB
HTML
Raw Normal View History

<!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 offsets with a DWARF section."><title>ReaderOffset in gimli::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="gimli" 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="../../gimli/index.html">gimli</a><span class="version">0.28.1</span></h2></div><h2 class="location"><a href="#">ReaderOffset</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.checked_sub">checked_sub</a></li><li><a href="#tymethod.from_i16">from_i16</a></li><li><a href="#tymethod.from_u16">from_u16</a></li><li><a href="#tymethod.from_u32">from_u32</a></li><li><a href="#tymethod.from_u64">from_u64</a></li><li><a href="#tymethod.from_u8">from_u8</a></li><li><a href="#tymethod.into_u64">into_u64</a></li><li><a href="#tymethod.wrapping_add">wrapping_add</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-ReaderOffset-for-u32">u32</a></li><li><a href="#impl-ReaderOffset-for-u64">u64</a></li><li><a href="#impl-ReaderOffset-for-usize">usize</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 gimli::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="../../gimli/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">gimli</a>::<wbr><a href="index.html">read</a>::<wbr><a class="trait" href="#">ReaderOffset</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/gimli/read/reader.rs.html#24-52">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 ReaderOffset: <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="https://doc.rust-lang.org/1.76.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/arith/trait.Add.html" title="trait core::ops::arith::Add">Add</a>&lt;Output = Self&gt; + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/arith/trait.AddAssign.html" title="trait core::ops::arith::AddAssign">AddAssign</a> + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a>&lt;Output = Self&gt; {
// Required methods
fn <a href="#tymethod.from_u8" class="fn">from_u8</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.from_u16" class="fn">from_u16</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u16.html">u16</a>) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.from_i16" class="fn">from_i16</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.i16.html">i16</a>) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.from_u32" class="fn">from_u32</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u32.html">u32</a>) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.from_u64" class="fn">from_u64</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>) -&gt; <a class="type" href="type.Result.html" title="type gimli::read::Result">Result</a>&lt;Self&gt;;
<span class="item-spacer"></span> fn <a href="#tymethod.into_u64" class="fn">into_u64</a>(self) -&gt; <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.wrapping_add" class="fn">wrapping_add</a>(self, other: Self) -&gt; Self;
<span class="item-spacer"></span> fn <a href="#tymethod.checked_sub" class="fn">checked_sub</a>(self, other: Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A trait for offsets with a DWARF section.</p>
<p>This allows consumers to choose a size that is appropriate for their address space.</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.from_u8" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#28">source</a><h4 class="code-header">fn <a href="#tymethod.from_u8" class="fn">from_u8</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Convert a u8 to an offset.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.from_u16" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#31">source</a><h4 class="code-header">fn <a href="#tymethod.from_u16" class="fn">from_u16</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u16.html">u16</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Convert a u16 to an offset.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.from_i16" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#34">source</a><h4 class="code-header">fn <a href="#tymethod.from_i16" class="fn">from_i16</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.i16.html">i16</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Convert an i16 to an offset.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.from_u32" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#37">source</a><h4 class="code-header">fn <a href="#tymethod.from_u32" class="fn">from_u32</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u32.html">u32</a>) -&gt; Self</h4></section></summary><div class="docblock"><p>Convert a u32 to an offset.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.from_u64" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#42">source</a><h4 class="code-header">fn <a href="#tymethod.from_u64" class="fn">from_u64</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>) -&gt; <a class="type" href="type.Result.html" title="type gimli::read::Result">Result</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Convert a u64 to an offset.</p>
<p>Returns <code>Error::UnsupportedOffset</code> if the value is too large.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.into_u64" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#45">source</a><h4 class="code-header">fn <a href="#tymethod.into_u64" class="fn">into_u64</a>(self) -&gt; <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>Convert an offset to a u64.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.wrapping_add" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#48">source</a><h4 class="code-header">fn <a href="#tymethod.wrapping_add" class="fn">wrapping_add</a>(self, other: Self) -&gt; Self</h4></section></summary><div class="docblock"><p>Wrapping (modular) addition. Computes <code>self + other</code>.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.checked_sub" class="method"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#51">source</a><h4 class="code-header">fn <a href="#tymethod.checked_sub" class="fn">checked_sub</a>(self, other: Self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.76.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Checked subtraction. Computes <code>self - other</code>.</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="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-ReaderOffset-for-u32" class="impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#96-141">source</a><a href="#impl-ReaderOffset-for-u32" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ReaderOffset.html" title="trait gimli::read::ReaderOffset">ReaderOffset</a> for <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u32.html">u32</a></h3></section></summary><div class="impl-items"><section id="method.from_u8" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#98-100">source</a><a href="#method.from_u8" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_u8" class="fn">from_u8</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u8.html">u8</a>) -&gt; Self</h4></section><section id="method.from_u16" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#103-105">source</a><a href="#method.from_u16" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_u16" class="fn">from_u16</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u16.html">u16</a>) -&gt; Self</h4></section><section id="method.from_i16" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#108-110">source</a><a href="#method.from_i16" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_i16" class="fn">from_i16</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.i16.html">i16</a>) -&gt; Self</h4></section><section id="method.from_u32" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#113-115">source</a><a href="#method.from_u32" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_u32" class="fn">from_u32</a>(offset: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u32.html">u32</a>) -&gt; Self</h4></section><section id="method.from_u64" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#118-125">source</a><a href="#method.from_u64" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.from_u64" class="fn">from_u64</a>(offset64: <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a>) -&gt; <a class="type" href="type.Result.html" title="type gimli::read::Result">Result</a>&lt;Self&gt;</h4></section><section id="method.into_u64" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#128-130">source</a><a href="#method.into_u64" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.into_u64" class="fn">into_u64</a>(self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.u64.html">u64</a></h4></section><section id="method.wrapping_add" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#133-135">source</a><a href="#method.wrapping_add" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.wrapping_add" class="fn">wrapping_add</a>(self, other: Self) -&gt; Self</h4></section><section id="method.checked_sub" class="method trait-impl"><a class="src rightside" href="../../src/gimli/read/reader.rs.html#138-140">source</a><a href="#method.checked_sub" class="anchor">§</a><h4 class="code-header">fn <a href="#tymethod.checked_sub" class="fn">checked_sub</a>(self, other: Self) -&gt; <a class="enum" href="https://doc.rust-lang.o