edlang/clap_builder/error/index.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="Error reporting"><title>clap_builder::error - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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 mod"><!--[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" title="show sidebar"></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.13</span></h2></div><h2 class="location"><a href="#">Module error</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate clap_builder</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">clap_builder</a>::<wbr><a class="mod" href="#">error</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/clap_builder/error/mod.rs.html#1-951">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Error reporting</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.DefaultFormatter"><code>pub use <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a> as DefaultFormatter;</code></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct clap_builder::error::Error">Error</a></div><div class="desc docblock-short">Command Line Argument Parser Error</div></li><li><div class="item-name"><a class="struct" href="struct.KindFormatter.html" title="struct clap_builder::error::KindFormatter">KindFormatter</a></div><div class="desc docblock-short">Report <a href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind"><code>ErrorKind</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></div><div class="desc docblock-short">Richly formatted error context</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ContextKind.html" title="enum clap_builder::error::ContextKind">ContextKind</a></div><div class="desc docblock-short">Semantics for a piece of error information</div></li><li><div class="item-name"><a class="enum" href="enum.ContextValue.html" title="enum clap_builder::error::ContextValue">ContextValue</a></div><div class="desc docblock-short">A piece of error information</div></li><li><div class="item-name"><a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></div><div class="desc docblock-short">Command line argument parser kind of error</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ErrorFormatter.html" title="trait clap_builder::error::ErrorFormatter">ErrorFormatter</a></div><div class="desc docblock-short">Defines how to format an error for displaying to the user</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Result.html" title="type clap_builder::error::Result">Result</a></div><div class="desc docblock-short">Short hand for <a href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a> type</div></li></ul></section></div></main></body></html>
deploy: 0d39a300f5fe3e8ab07cda8b36c3b377b69cbdff 2024-08-01 07:04:26 +00:00			<!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="Error reporting"><title>clap_builder::error - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.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.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><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 mod"><!--[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" title="show sidebar"></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.13</span></h2></div><h2 class="location"><a href="#">Module error</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In crate clap_builder</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">clap_builder</a>::<wbr><a class="mod" href="#">error</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/clap_builder/error/mod.rs.html#1-951">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Error reporting</p>
deploy: b3bd34a9bbae9c73eb2d66a212d6921bd7499b69 2024-07-26 09:42:18 +00:00			</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.DefaultFormatter"><code>pub use <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a> as DefaultFormatter;</code></div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Error.html" title="struct clap_builder::error::Error">Error</a></div><div class="desc docblock-short">Command Line Argument Parser Error</div></li><li><div class="item-name"><a class="struct" href="struct.KindFormatter.html" title="struct clap_builder::error::KindFormatter">KindFormatter</a></div><div class="desc docblock-short">Report <a href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind"><code>ErrorKind</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></div><div class="desc docblock-short">Richly formatted error context</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.ContextKind.html" title="enum clap_builder::error::ContextKind">ContextKind</a></div><div class="desc docblock-short">Semantics for a piece of error information</div></li><li><div class="item-name"><a class="enum" href="enum.ContextValue.html" title="enum clap_builder::error::ContextValue">ContextValue</a></div><div class="desc docblock-short">A piece of error information</div></li><li><div class="item-name"><a class="enum" href="enum.ErrorKind.html" title="enum clap_builder::error::ErrorKind">ErrorKind</a></div><div class="desc docblock-short">Command line argument parser kind of error</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.ErrorFormatter.html" title="trait clap_builder::error::ErrorFormatter">ErrorFormatter</a></div><div class="desc docblock-short">Defines how to format an error for displaying to the user</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Result.html" title="type clap_builder::error::Result">Result</a></div><div class="desc docblock-short">Short hand for <a href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a> type</div></li></ul></section></div></main></body></html>