deploy: de38ae62916547ad097c066f94a32e9ba7790eeb

This commit is contained in:
NotAShelf 2025-02-05 00:10:33 +00:00
commit 9a86359447
28502 changed files with 1261284 additions and 0 deletions

1
clap_builder/all.html Normal file

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/enum.ArgAction.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/enum.ArgAction.html">../../../clap_builder/builder/enum.ArgAction.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/enum.ArgAction.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.Arg.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.Arg.html">../../../clap_builder/builder/struct.Arg.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.Arg.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.ArgGroup.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.ArgGroup.html">../../../clap_builder/builder/struct.ArgGroup.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.ArgGroup.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/enum.ArgPredicate.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/enum.ArgPredicate.html">../../../clap_builder/builder/enum.ArgPredicate.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/enum.ArgPredicate.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.Command.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.Command.html">../../../clap_builder/builder/struct.Command.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.Command.html" + location.search + location.hash);</script>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.OsStr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.OsStr.html">../../../clap_builder/builder/struct.OsStr.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.OsStr.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.PossibleValue.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.PossibleValue.html">../../../clap_builder/builder/struct.PossibleValue.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.PossibleValue.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.ValueRange.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.ValueRange.html">../../../clap_builder/builder/struct.ValueRange.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.ValueRange.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/enum.Resettable.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/enum.Resettable.html">../../../clap_builder/builder/enum.Resettable.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/enum.Resettable.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/trait.IntoResettable.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/trait.IntoResettable.html">../../../clap_builder/builder/trait.IntoResettable.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/trait.IntoResettable.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["ArgAction","ArgPredicate","Resettable","ValueHint"],"mod":["styling"],"struct":["Arg","ArgGroup","BoolValueParser","BoolishValueParser","Command","EnumValueParser","FalseyValueParser","MapValueParser","NonEmptyStringValueParser","OsStr","OsStringValueParser","PathBufValueParser","PossibleValue","PossibleValuesParser","RangedI64ValueParser","RangedU64ValueParser","Str","StringValueParser","StyledStr","TryMapValueParser","UnknownArgumentValueParser","ValueParser","ValueRange"],"trait":["IntoResettable","TypedValueParser","ValueParserFactory"]};

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.Str.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.Str.html">../../../clap_builder/builder/struct.Str.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.Str.html" + location.search + location.hash);</script>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.StyledStr.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.StyledStr.html">../../../clap_builder/builder/struct.StyledStr.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.StyledStr.html" + location.search + location.hash);</script>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,2 @@
<!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="Terminal `Styles` for help and error output"><title>clap_builder::builder::styling - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.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_<wbr>builder</a><span class="version">4.5.23</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module styling</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In clap_<wbr>builder::<wbr>builder</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../../index.html">clap_builder</a>::<wbr><a href="../index.html">builder</a></span><h1>Module <span>styling</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../../src/clap_builder/builder/styling.rs.html#1-177">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Terminal <a href="struct.Styles.html" title="struct clap_builder::builder::styling::Styles"><code>Styles</code></a> for help and error output</p>
</div></details><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.Ansi256Color.html" title="struct clap_builder::builder::styling::Ansi256Color">Ansi256<wbr>Color</a></div><div class="desc docblock-short">256 (8-bit) color support</div></li><li><div class="item-name"><a class="struct" href="struct.EffectIter.html" title="struct clap_builder::builder::styling::EffectIter">Effect<wbr>Iter</a></div><div class="desc docblock-short">Enumerate each enabled value in <a href="struct.Effects.html" title="struct clap_builder::builder::styling::Effects"><code>Effects</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.Effects.html" title="struct clap_builder::builder::styling::Effects">Effects</a></div><div class="desc docblock-short">A set of text effects</div></li><li><div class="item-name"><a class="struct" href="struct.Reset.html" title="struct clap_builder::builder::styling::Reset">Reset</a></div><div class="desc docblock-short">Reset terminal formatting</div></li><li><div class="item-name"><a class="struct" href="struct.RgbColor.html" title="struct clap_builder::builder::styling::RgbColor">RgbColor</a></div><div class="desc docblock-short">24-bit ANSI RGB color codes</div></li><li><div class="item-name"><a class="struct" href="struct.Style.html" title="struct clap_builder::builder::styling::Style">Style</a></div><div class="desc docblock-short">ANSI Text styling</div></li><li><div class="item-name"><a class="struct" href="struct.Styles.html" title="struct clap_builder::builder::styling::Styles">Styles</a></div><div class="desc docblock-short">Terminal styling definitions</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.AnsiColor.html" title="enum clap_builder::builder::styling::AnsiColor">Ansi<wbr>Color</a></div><div class="desc docblock-short">Available 4-bit ANSI color palette codes</div></li><li><div class="item-name"><a class="enum" href="enum.Color.html" title="enum clap_builder::builder::styling::Color">Color</a></div><div class="desc docblock-short">Any ANSI color code scheme</div></li></ul></section></div></main></body></html>

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["AnsiColor","Color"],"struct":["Ansi256Color","EffectIter","Effects","Reset","RgbColor","Style","Styles"]};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/enum.ValueHint.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/enum.ValueHint.html">../../../clap_builder/builder/enum.ValueHint.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/enum.ValueHint.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.BoolValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.BoolValueParser.html">../../../clap_builder/builder/struct.BoolValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.BoolValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.BoolishValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.BoolishValueParser.html">../../../clap_builder/builder/struct.BoolishValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.BoolishValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.EnumValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.EnumValueParser.html">../../../clap_builder/builder/struct.EnumValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.EnumValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.FalseyValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.FalseyValueParser.html">../../../clap_builder/builder/struct.FalseyValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.FalseyValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.MapValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.MapValueParser.html">../../../clap_builder/builder/struct.MapValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.MapValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.NonEmptyStringValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.NonEmptyStringValueParser.html">../../../clap_builder/builder/struct.NonEmptyStringValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.NonEmptyStringValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.OsStringValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.OsStringValueParser.html">../../../clap_builder/builder/struct.OsStringValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.OsStringValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.PathBufValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.PathBufValueParser.html">../../../clap_builder/builder/struct.PathBufValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.PathBufValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.PossibleValuesParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.PossibleValuesParser.html">../../../clap_builder/builder/struct.PossibleValuesParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.PossibleValuesParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.RangedI64ValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.RangedI64ValueParser.html">../../../clap_builder/builder/struct.RangedI64ValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.RangedI64ValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.RangedU64ValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.RangedU64ValueParser.html">../../../clap_builder/builder/struct.RangedU64ValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.RangedU64ValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.StringValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.StringValueParser.html">../../../clap_builder/builder/struct.StringValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.StringValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.TryMapValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.TryMapValueParser.html">../../../clap_builder/builder/struct.TryMapValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.TryMapValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.UnknownArgumentValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.UnknownArgumentValueParser.html">../../../clap_builder/builder/struct.UnknownArgumentValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.UnknownArgumentValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/struct.ValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/struct.ValueParser.html">../../../clap_builder/builder/struct.ValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/struct.ValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/trait.TypedValueParser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/trait.TypedValueParser.html">../../../clap_builder/builder/trait.TypedValueParser.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/trait.TypedValueParser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/builder/trait.ValueParserFactory.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/builder/trait.ValueParserFactory.html">../../../clap_builder/builder/trait.ValueParserFactory.html</a>...</p>
<script>location.replace("../../../clap_builder/builder/trait.ValueParserFactory.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../clap_builder/trait.Args.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../clap_builder/trait.Args.html">../../clap_builder/trait.Args.html</a>...</p>
<script>location.replace("../../clap_builder/trait.Args.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../clap_builder/trait.CommandFactory.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../clap_builder/trait.CommandFactory.html">../../clap_builder/trait.CommandFactory.html</a>...</p>
<script>location.replace("../../clap_builder/trait.CommandFactory.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../clap_builder/trait.FromArgMatches.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../clap_builder/trait.FromArgMatches.html">../../clap_builder/trait.FromArgMatches.html</a>...</p>
<script>location.replace("../../clap_builder/trait.FromArgMatches.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../clap_builder/trait.Parser.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../clap_builder/trait.Parser.html">../../clap_builder/trait.Parser.html</a>...</p>
<script>location.replace("../../clap_builder/trait.Parser.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../clap_builder/trait.Subcommand.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../clap_builder/trait.Subcommand.html">../../clap_builder/trait.Subcommand.html</a>...</p>
<script>location.replace("../../clap_builder/trait.Subcommand.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../clap_builder/trait.ValueEnum.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../clap_builder/trait.ValueEnum.html">../../clap_builder/trait.ValueEnum.html</a>...</p>
<script>location.replace("../../clap_builder/trait.ValueEnum.html" + location.search + location.hash);</script>
</body>
</html>

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/error/enum.ContextKind.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/error/enum.ContextKind.html">../../../clap_builder/error/enum.ContextKind.html</a>...</p>
<script>location.replace("../../../clap_builder/error/enum.ContextKind.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/error/enum.ContextValue.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/error/enum.ContextValue.html">../../../clap_builder/error/enum.ContextValue.html</a>...</p>
<script>location.replace("../../../clap_builder/error/enum.ContextValue.html" + location.search + location.hash);</script>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/error/struct.KindFormatter.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/error/struct.KindFormatter.html">../../../clap_builder/error/struct.KindFormatter.html</a>...</p>
<script>location.replace("../../../clap_builder/error/struct.KindFormatter.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/error/struct.RichFormatter.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/error/struct.RichFormatter.html">../../../clap_builder/error/struct.RichFormatter.html</a>...</p>
<script>location.replace("../../../clap_builder/error/struct.RichFormatter.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/error/trait.ErrorFormatter.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/error/trait.ErrorFormatter.html">../../../clap_builder/error/trait.ErrorFormatter.html</a>...</p>
<script>location.replace("../../../clap_builder/error/trait.ErrorFormatter.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,2 @@
<!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-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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_<wbr>builder</a><span class="version">4.5.23</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module error</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate clap_<wbr>builder</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">clap_builder</a></span><h1>Module <span>error</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/clap_builder/error/mod.rs.html#1-934">Source</a> </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">Kind<wbr>Formatter</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">Rich<wbr>Formatter</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">Context<wbr>Kind</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">Context<wbr>Value</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">Error<wbr>Kind</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">Error<wbr>Formatter</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.84.1/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a> type</div></li></ul></section></div></main></body></html>

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../../clap_builder/error/enum.ErrorKind.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../../clap_builder/error/enum.ErrorKind.html">../../../clap_builder/error/enum.ErrorKind.html</a>...</p>
<script>location.replace("../../../clap_builder/error/enum.ErrorKind.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1 @@
window.SIDEBAR_ITEMS = {"enum":["ContextKind","ContextValue","ErrorKind"],"struct":["Error","KindFormatter","RichFormatter"],"trait":["ErrorFormatter"],"type":["Result"]};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,13 @@
<!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="Richly formatted error context"><title>RichFormatter in clap_builder::error - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[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_<wbr>builder</a><span class="version">4.5.23</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Rich<wbr>Formatter</a></h2><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-ErrorFormatter-for-RichFormatter" title="ErrorFormatter">ErrorFormatter</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-RichFormatter" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-RichFormatter" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-RichFormatter" title="Send">Send</a></li><li><a href="#impl-Sync-for-RichFormatter" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-RichFormatter" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RichFormatter" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In clap_<wbr>builder::<wbr>error</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">clap_builder</a>::<wbr><a href="index.html">error</a></span><h1>Struct <span class="struct">RichFormatter</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/clap_builder/error/format.rs.html#62">Source</a> </span></div><pre class="rust item-decl"><code><div class="code-attribute">#[non_exhaustive]</div>pub struct RichFormatter;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Richly formatted error context</p>
<p>This follows the <a href="https://rustc-dev-guide.rust-lang.org/diagnostics.html#suggestion-style-guide">rustc diagnostic style guide</a>.</p>
</div></details><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-ErrorFormatter-for-RichFormatter" class="impl"><a class="src rightside" href="../../src/clap_builder/error/format.rs.html#65-129">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></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.format_error" class="method trait-impl"><a class="src rightside" href="../../src/clap_builder/error/format.rs.html#66-128">Source</a><a href="#method.format_error" class="anchor">§</a><h4 class="code-header">fn <a href="trait.ErrorFormatter.html#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'>Stylize the error for the terminal</div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-RichFormatter" class="impl"><a href="#impl-Freeze-for-RichFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-RefUnwindSafe-for-RichFormatter" class="impl"><a href="#impl-RefUnwindSafe-for-RichFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Send-for-RichFormatter" class="impl"><a href="#impl-Send-for-RichFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Sync-for-RichFormatter" class="impl"><a href="#impl-Sync-for-RichFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-Unpin-for-RichFormatter" class="impl"><a href="#impl-Unpin-for-RichFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></h3></section><section id="impl-UnwindSafe-for-RichFormatter" class="impl"><a href="#impl-UnwindSafe-for-RichFormatter" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.RichFormatter.html" title="struct clap_builder::error::RichFormatter">RichFormatter</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.84.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.84.1/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.1/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>

View file

@ -0,0 +1,6 @@
<!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><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" 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_<wbr>builder</a><span class="version">4.5.23</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Error<wbr>Formatter</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.format_error" title="format_error">format_error</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In clap_<wbr>builder::<wbr>error</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">clap_builder</a>::<wbr><a href="index.html">error</a></span><h1>Trait <span class="trait">ErrorFormatter</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/clap_builder/error/format.rs.html#20-23">Source</a> </span></div><pre class="rust item-decl"><code>pub trait ErrorFormatter: <a class="trait" href="https://doc.rust-lang.org/1.84.1/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#22">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="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.1/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></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#38-55">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#65-129">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>

View file

@ -0,0 +1,7 @@
<!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="Short hand for `Result` type"><title>Result in clap_builder::error - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc type"><!--[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_<wbr>builder</a><span class="version">4.5.23</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Result</a></h2><h3><a href="#aliased-type">Aliased type</a></h3><h3><a href="#variants">Variants</a></h3><ul class="block variant"><li><a href="#variant.Err" title="Err">Err</a></li><li><a href="#variant.Ok" title="Ok">Ok</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In clap_<wbr>builder::<wbr>error</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="../index.html">clap_builder</a>::<wbr><a href="index.html">error</a></span><h1>Type Alias <span class="type">Result</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/clap_builder/error/mod.rs.html#53">Source</a> </span></div><pre class="rust item-decl"><code>pub type Result&lt;T, E = <a class="struct" href="struct.Error.html" title="struct clap_builder::error::Error">Error</a>&gt; = <a class="enum" href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, E&gt;;</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Short hand for <a href="https://doc.rust-lang.org/1.84.1/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a> type</p>
</div></details><h2 id="aliased-type" class="section-header">Aliased Type<a href="#aliased-type" class="anchor">§</a></h2><pre class="rust item-decl"><code>enum Result&lt;T, E = <a class="struct" href="struct.Error.html" title="struct clap_builder::error::Error">Error</a>&gt; {
Ok(T),
Err(E),
}</code></pre><h2 id="variants" class="variants section-header">Variants<a href="#variants" class="anchor">§</a></h2><div class="variants"><section id="variant.Ok" class="variant"><a href="#variant.Ok" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Ok(T)</h3></section><div class="docblock"><p>Contains the success value</p>
</div><section id="variant.Err" class="variant"><a href="#variant.Err" class="anchor">§</a><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><h3 class="code-header">Err(E)</h3></section><div class="docblock"><p>Contains the error value</p>
</div></div><script src="../../type.impl/core/result/enum.Result.js" data-self-path="clap_builder::error::Result" async></script></section></div></main></body></html>

20
clap_builder/index.html Normal file

File diff suppressed because one or more lines are too long

View file

@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=macro.arg.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="macro.arg.html">macro.arg.html</a>...</p>
<script>location.replace("macro.arg.html" + location.search + location.hash);</script>
</body>
</html>

View file

@ -0,0 +1,66 @@
<!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="Create an `Arg` from a usage string."><title>arg in clap_builder - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.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.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc macro"><!--[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_<wbr>builder</a><span class="version">4.5.23</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">arg</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#syntax" title="Syntax">Syntax</a><ul><li><a href="#explicit-name" title="Explicit Name">Explicit Name</a></li><li><a href="#short" title="Short">Short</a></li><li><a href="#long" title="Long">Long</a></li><li><a href="#values-value-notation" title="Values (Value Notation)">Values (Value Notation)</a></li><li><a href="#" title="`...`"><code>...</code></a></li><li><a href="#help-string" title="Help String">Help String</a></li></ul></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate clap_<wbr>builder</a></h2></div></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"><span class="rustdoc-breadcrumbs"><a href="index.html">clap_builder</a></span><h1>Macro <span class="macro">arg</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/clap_builder/macros.rs.html#532-548">Source</a> </span></div><pre class="rust item-decl"><code>macro_rules! arg {
( $name:ident: $($tail:tt)+ ) =&gt; { ... };
( $($tail:tt)+ ) =&gt; { ... };
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Create an <a href="builder/struct.Arg.html" title="struct clap_builder::builder::Arg"><code>Arg</code></a> from a usage string.</p>
<p>Allows creation of basic settings for the <a href="builder/struct.Arg.html" title="struct clap_builder::builder::Arg"><code>Arg</code></a>.</p>
<div class="warning">
<p><strong>NOTE</strong>: Not all settings may be set using the usage string method. Some properties are
only available via the builder pattern.</p>
</div>
<h2 id="syntax"><a class="doc-anchor" href="#syntax">§</a>Syntax</h2>
<p>Usage strings typically following the form:</p>
<div class="example-wrap"><pre class="language-notrust"><code>[explicit name] [short] [long] [value names] [...] [help string]</code></pre></div><h4 id="explicit-name"><a class="doc-anchor" href="#explicit-name">§</a>Explicit Name</h4>
<p>The name may be either a bare-word or a string, followed by a <code>:</code>, like <code>name:</code> or
<code>"name":</code>.</p>
<p><em>Note:</em> This is an optional field, if its omitted the argument will use one of the additional
fields as the name using the following priority order:</p>
<ol>
<li>Explicit Name</li>
<li>Long</li>
<li>Value Name</li>
</ol>
<p>See <a href="builder/struct.Arg.html#method.id" title="method clap_builder::builder::Arg::id"><code>Arg::id</code></a>.</p>
<h4 id="short"><a class="doc-anchor" href="#short">§</a>Short</h4>
<p>A short flag is a <code>-</code> followed by either a bare-character or quoted character, like <code>-f</code> or
<code>-'f'</code>.</p>
<p>See <a href="builder/struct.Arg.html#method.short" title="method clap_builder::builder::Arg::short"><code>Arg::short</code></a>.</p>
<h4 id="long"><a class="doc-anchor" href="#long">§</a>Long</h4>
<p>A long flag is a <code>--</code> followed by either a bare-word or a string, like <code>--foo</code> or
<code>--"foo"</code>.</p>
<div class="warning">
<p><strong>NOTE:</strong> Dashes in the long name (e.g. <code>--foo-bar</code>) is not supported and quoting is required
(e.g. <code>--"foo-bar"</code>).</p>
</div>
<p>See <a href="builder/struct.Arg.html#method.long" title="method clap_builder::builder::Arg::long"><code>Arg::long</code></a>.</p>
<h4 id="values-value-notation"><a class="doc-anchor" href="#values-value-notation">§</a>Values (Value Notation)</h4>
<p>This is set by placing bare-word between:</p>
<ul>
<li><code>[]</code> like <code>[FOO]</code>
<ul>
<li>Positional argument: optional</li>
<li>Named argument: optional value</li>
</ul>
</li>
<li><code>&lt;&gt;</code> like <code>&lt;FOO&gt;</code>: required</li>
</ul>
<p>See <a href="builder/struct.Arg.html#method.value_name" title="method clap_builder::builder::Arg::value_name"><code>Arg::value_name</code></a>.</p>
<h4 id=""><a class="doc-anchor" href="#">§</a><code>...</code></h4>
<p><code>...</code> (three consecutive dots/periods) specifies that this argument may occur multiple
times (not to be confused with multiple values per occurrence).</p>
<p>See <a href="builder/enum.ArgAction.html#variant.Count" title="variant clap_builder::builder::ArgAction::Count"><code>ArgAction::Count</code></a> and <a href="builder/enum.ArgAction.html#variant.Append" title="variant clap_builder::builder::ArgAction::Append"><code>ArgAction::Append</code></a>.</p>
<h4 id="help-string"><a class="doc-anchor" href="#help-string">§</a>Help String</h4>
<p>The help string is denoted between a pair of double quotes <code>""</code> and may contain any
characters.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>cmd = Command::new(<span class="string">"prog"</span>)
.args(<span class="kw-2">&amp;</span>[
<span class="macro">arg!</span>(--config &lt;FILE&gt; <span class="string">"a required file for the configuration and no short"</span>),
<span class="macro">arg!</span>(-d --debug ... <span class="string">"turns on debugging information and allows multiples"</span>),
<span class="macro">arg!</span>([input] <span class="string">"an optional input file to use"</span>)
]);
<span class="kw">let </span>m = cmd.try_get_matches_from([<span class="string">"prog"</span>, <span class="string">"--config"</span>, <span class="string">"file.toml"</span>]).unwrap();
<span class="macro">assert_eq!</span>(m.get_one::&lt;String&gt;(<span class="string">"config"</span>).unwrap(), <span class="string">"file.toml"</span>);
<span class="macro">assert_eq!</span>(<span class="kw-2">*</span>m.get_one::&lt;u8&gt;(<span class="string">"debug"</span>).unwrap(), <span class="number">0</span>);
<span class="macro">assert_eq!</span>(m.get_one::&lt;String&gt;(<span class="string">"input"</span>), <span class="prelude-val">None</span>);</code></pre></div>
</div></details></section></div></main></body></html>

Some files were not shown because too many files have changed in this diff Show more