edlang/clap_builder/error/trait.ErrorFormatter.html
2024-02-27 06:59:44 +00:00

7 lines
7.5 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="Defines how to format an error for displaying to the user"><title>ErrorFormatter in clap_builder::error - 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="clap_builder" 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><a class="logo-container" href="../../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../clap_builder/index.html"><img src="https://raw.githubusercontent.com/clap-rs/clap/master/assets/clap.png" alt="logo"></a><h2><a href="../../clap_builder/index.html">clap_builder</a><span class="version">4.5.1</span></h2></div><h2 class="location"><a href="#">ErrorFormatter</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.format_error">format_error</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 clap_builder::error</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="../../clap_builder/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">clap_builder</a>::<wbr><a href="index.html">error</a>::<wbr><a class="trait" href="#">ErrorFormatter</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/clap_builder/error/format.rs.html#17-20">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 ErrorFormatter: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
// Required method
fn <a href="#tymethod.format_error" class="fn">format_error</a>(error: &amp;<a class="struct" href="struct.Error.html" title="struct clap_builder::error::Error">Error</a>&lt;Self&gt;) -&gt; <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap_builder::builder::StyledStr">StyledStr</a>;
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Defines how to format an error for displaying to the user</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.format_error" class="method"><a class="src rightside" href="../../src/clap_builder/error/format.rs.html#19">source</a><h4 class="code-header">fn <a href="#tymethod.format_error" class="fn">format_error</a>(error: &amp;<a class="struct" href="struct.Error.html" title="struct clap_builder::error::Error">Error</a>&lt;Self&gt;) -&gt; <a class="struct" href="../builder/struct.StyledStr.html" title="struct clap_builder::builder::StyledStr">StyledStr</a></h4></section></summary><div class="docblock"><p>Stylize the error for the terminal</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"><section id="impl-ErrorFormatter-for-KindFormatter" class="impl"><a class="src rightside" href="../../src/clap_builder/error/format.rs.html#31-48">source</a><a href="#impl-ErrorFormatter-for-KindFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ErrorFormatter.html" title="trait clap_builder::error::ErrorFormatter">ErrorFormatter</a> for <a class="struct" href="struct.KindFormatter.html" title="struct clap_builder::error::KindFormatter">KindFormatter</a></h3></section><section id="impl-ErrorFormatter-for-RichFormatter" class="impl"><a class="src rightside" href="../../src/clap_builder/error/format.rs.html#58-127">source</a><a href="#impl-ErrorFormatter-for-RichFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.ErrorFormatter.html" title="trait clap_builder::error::ErrorFormatter">ErrorFormatter</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></h3></section></div><script src="../../trait.impl/clap_builder/error/format/trait.ErrorFormatter.js" async></script></section></div></main></body></html>