mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
29 lines
11 KiB
HTML
29 lines
11 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="Specification of what storage should be used for `UnwindContext`."><title>UnwindContextStorage 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">☰</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="#">UnwindContextStorage</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.Rules">Rules</a></li><li><a href="#associatedtype.Stack">Stack</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="#">UnwindContextStorage</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/cfi.rs.html#1903-1911">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait UnwindContextStorage<R: <a class="trait" href="trait.Reader.html" title="trait gimli::read::Reader">Reader</a>>: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
type <a href="#associatedtype.Rules" class="associatedtype">Rules</a>: <a class="trait" href="trait.ArrayLike.html" title="trait gimli::read::ArrayLike">ArrayLike</a><Item = (<a class="struct" href="../struct.Register.html" title="struct gimli::Register">Register</a>, <a class="enum" href="enum.RegisterRule.html" title="enum gimli::read::RegisterRule">RegisterRule</a><R>)>;
|
||
type <a href="#associatedtype.Stack" class="associatedtype">Stack</a>: <a class="trait" href="trait.ArrayLike.html" title="trait gimli::read::ArrayLike">ArrayLike</a><Item = <a class="struct" href="struct.UnwindTableRow.html" title="struct gimli::read::UnwindTableRow">UnwindTableRow</a><R, Self>>;
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Specification of what storage should be used for <a href="struct.UnwindContext.html" title="struct gimli::read::UnwindContext"><code>UnwindContext</code></a>.</p>
|
||
<p>Normally you would only need to use <a href="struct.StoreOnHeap.html" title="struct gimli::read::StoreOnHeap"><code>StoreOnHeap</code></a>, which places the stack
|
||
on the heap using [<code>Vec</code>]. This is the default storage type parameter for <a href="struct.UnwindContext.html" title="struct gimli::read::UnwindContext"><code>UnwindContext</code></a>.</p>
|
||
<p>If you need to avoid <a href="struct.UnwindContext.html" title="struct gimli::read::UnwindContext"><code>UnwindContext</code></a> from allocating memory, e.g. for signal safety,
|
||
you can provide you own storage specification:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">struct </span>StoreOnStack;
|
||
|
||
<span class="kw">impl</span><R: Reader> UnwindContextStorage<R> <span class="kw">for </span>StoreOnStack {
|
||
<span class="kw">type </span>Rules = [(Register, RegisterRule<R>); <span class="number">192</span>];
|
||
<span class="kw">type </span>Stack = [UnwindTableRow<R, <span class="self">Self</span>>; <span class="number">4</span>];
|
||
}
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>ctx = UnwindContext::<<span class="kw">_</span>, StoreOnStack>::new_in();
|
||
|
||
<span class="comment">// Initialize the context by evaluating the CIE's initial instruction program,
|
||
// and generate the unwind table.
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>table = some_fde.rows(<span class="kw-2">&</span>eh_frame, <span class="kw-2">&</span>bases, <span class="kw-2">&mut </span>ctx)<span class="question-mark">?</span>;
|
||
<span class="kw">while let </span><span class="prelude-val">Some</span>(row) = table.next_row()<span class="question-mark">? </span>{
|
||
<span class="comment">// Do stuff with each row...
|
||
</span>}</code></pre></div>
|
||
</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.Rules" class="method"><a class="src rightside" href="../../src/gimli/read/cfi.rs.html#1907">source</a><h4 class="code-header">type <a href="#associatedtype.Rules" class="associatedtype">Rules</a>: <a class="trait" href="trait.ArrayLike.html" title="trait gimli::read::ArrayLike">ArrayLike</a><Item = (<a class="struct" href="../struct.Register.html" title="struct gimli::Register">Register</a>, <a class="enum" href="enum.RegisterRule.html" title="enum gimli::read::RegisterRule">RegisterRule</a><R>)></h4></section></summary><div class="docblock"><p>The storage used for register rules in a unwind table row.</p>
|
||
<p>Note that this is nested within the stack.</p>
|
||
</div></details><details class="toggle" open><summary><section id="associatedtype.Stack" class="method"><a class="src rightside" href="../../src/gimli/read/cfi.rs.html#1910">source</a><h4 class="code-header">type <a href="#associatedtype.Stack" class="associatedtype">Stack</a>: <a class="trait" href="trait.ArrayLike.html" title="trait gimli::read::ArrayLike">ArrayLike</a><Item = <a class="struct" href="struct.UnwindTableRow.html" title="struct gimli::read::UnwindTableRow">UnwindTableRow</a><R, Self>></h4></section></summary><div class="docblock"><p>The storage used for unwind table row stack.</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-UnwindContextStorage%3CR%3E-for-StoreOnHeap" class="impl"><a class="src rightside" href="../../src/gimli/read/cfi.rs.html#1919-1922">source</a><a href="#impl-UnwindContextStorage%3CR%3E-for-StoreOnHeap" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.Reader.html" title="trait gimli::read::Reader">Reader</a>> <a class="trait" href="trait.UnwindContextStorage.html" title="trait gimli::read::UnwindContextStorage">UnwindContextStorage</a><R> for <a class="struct" href="struct.StoreOnHeap.html" title="struct gimli::read::StoreOnHeap">StoreOnHeap</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Rules-1" class="associatedtype trait-impl"><a href="#associatedtype.Rules-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Rules" class="associatedtype">Rules</a> = [(<a class="struct" href="../struct.Register.html" title="struct gimli::Register">Register</a>, <a class="enum" href="enum.RegisterRule.html" title="enum gimli::read::RegisterRule">RegisterRule</a><R>); <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">192</a>]</h4></section><section id="associatedtype.Stack-1" class="associatedtype trait-impl"><a href="#associatedtype.Stack-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Stack" class="associatedtype">Stack</a> = <a class="struct" href="https://doc.rust-lang.org/1.76.0/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><[<a class="struct" href="struct.UnwindTableRow.html" title="struct gimli::read::UnwindTableRow">UnwindTableRow</a><R>; <a class="primitive" href="https://doc.rust-lang.org/1.76.0/core/primitive.array.html">4</a>]></h4></section></div></details></div><script src="../../trait.impl/gimli/read/cfi/trait.UnwindContextStorage.js" async></script></section></div></main></body></html> |