mirror of
https://github.com/edg-l/edlang.git
synced 2024-09-20 01:24:23 +00:00
22 lines
5.4 KiB
HTML
22 lines
5.4 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="Install the default panic and error report hooks"><title>install in color_eyre - 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="color_eyre" 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 fn"><!--[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="../color_eyre/index.html">color_eyre</a><span class="version">0.6.2</span></h2></div><div class="sidebar-elems"></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="../color_eyre/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>Function <a href="index.html">color_eyre</a>::<wbr><a class="fn" href="#">install</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/color_eyre/lib.rs.html#460-462">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn install() -> <a class="type" href="../eyre/type.Result.html" title="type eyre::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.76.0/std/primitive.unit.html">()</a>, <a class="struct" href="../eyre/struct.Report.html" title="struct eyre::Report">Report</a>></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Install the default panic and error report hooks</p>
|
|||
|
|
<h2 id="details"><a href="#details">Details</a></h2>
|
|||
|
|
<p>This function must be called to enable the customization of <code>eyre::Report</code>
|
|||
|
|
provided by <code>color-eyre</code>. This function should be called early, ideally
|
|||
|
|
before any errors could be encountered.</p>
|
|||
|
|
<p>Only the first install will succeed. Calling this function after another
|
|||
|
|
report handler has been installed will cause an error. <strong>Note</strong>: This
|
|||
|
|
function <em>must</em> be called before any <code>eyre::Report</code>s are constructed to
|
|||
|
|
prevent the default handler from being installed.</p>
|
|||
|
|
<p>Installing a global theme in <code>color_spantrace</code> manually (by calling
|
|||
|
|
<code>color_spantrace::set_theme</code> or <code>color_spantrace::colorize</code> before
|
|||
|
|
<code>install</code> is called) will result in an error if this function is called.</p>
|
|||
|
|
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>color_eyre::eyre::Result;
|
|||
|
|
|
|||
|
|
<span class="kw">fn </span>main() -> <span class="prelude-ty">Result</span><()> {
|
|||
|
|
color_eyre::install()<span class="question-mark">?</span>;
|
|||
|
|
|
|||
|
|
<span class="comment">// ...
|
|||
|
|
</span>}</code></pre></div>
|
|||
|
|
</div></details></section></div></main></body></html>
|