mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
109 lines
12 KiB
HTML
109 lines
12 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Minimal, flexible command-line parser"><title>clap_lex - Rust</title><script> if (window.location.protocol !== "file:") document.write(`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2">`)</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-e935ef01ae1c1829.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="clap_lex" data-themes="" data-resource-suffix="" data-rustdoc-version="1.78.0 (9b00956e5 2024-04-29)" data-channel="1.78.0" data-search-js="search-42d8da7a6b9792c2.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-4c98445ec4002617.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-12cf3b4f4f9dc36d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-04d5337699b92874.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../clap_lex/index.html">clap_lex</a><span class="version">0.7.0</span></h2></div><div class="sidebar-elems"><ul class="block">
|
||
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../clap_lex/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">clap_lex</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/clap_lex/lib.rs.html#1-505">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>Minimal, flexible command-line parser</p>
|
||
<p>As opposed to a declarative parser, this processes arguments as a stream of tokens. As lexing
|
||
a command-line is not context-free, we rely on the caller to decide how to interpret the
|
||
arguments.</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">use </span>std::path::PathBuf;
|
||
<span class="kw">use </span>std::ffi::OsStr;
|
||
|
||
<span class="kw">type </span>BoxedError = Box<<span class="kw">dyn </span>std::error::Error + Send + Sync>;
|
||
|
||
<span class="attr">#[derive(Debug)]
|
||
</span><span class="kw">struct </span>Args {
|
||
paths: Vec<PathBuf>,
|
||
color: Color,
|
||
verbosity: usize,
|
||
}
|
||
|
||
<span class="attr">#[derive(Debug)]
|
||
</span><span class="kw">enum </span>Color {
|
||
Always,
|
||
Auto,
|
||
Never,
|
||
}
|
||
|
||
<span class="kw">impl </span>Color {
|
||
<span class="kw">fn </span>parse(s: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>OsStr>) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, BoxedError> {
|
||
<span class="kw">let </span>s = s.map(|s| s.to_str().ok_or(s));
|
||
<span class="kw">match </span>s {
|
||
<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="string">"always"</span>)) | <span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="string">""</span>)) | <span class="prelude-val">None </span>=> {
|
||
<span class="prelude-val">Ok</span>(Color::Always)
|
||
}
|
||
<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="string">"auto"</span>)) => {
|
||
<span class="prelude-val">Ok</span>(Color::Auto)
|
||
}
|
||
<span class="prelude-val">Some</span>(<span class="prelude-val">Ok</span>(<span class="string">"never"</span>)) => {
|
||
<span class="prelude-val">Ok</span>(Color::Never)
|
||
}
|
||
<span class="prelude-val">Some</span>(invalid) => {
|
||
<span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"Invalid value for `--color`, {invalid:?}"</span>).into())
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="kw">fn </span>parse_args(
|
||
raw: <span class="kw">impl </span>IntoIterator<Item=<span class="kw">impl </span>Into<std::ffi::OsString>>
|
||
) -> <span class="prelude-ty">Result</span><Args, BoxedError> {
|
||
<span class="kw">let </span><span class="kw-2">mut </span>args = Args {
|
||
paths: Vec::new(),
|
||
color: Color::Auto,
|
||
verbosity: <span class="number">0</span>,
|
||
};
|
||
|
||
<span class="kw">let </span>raw = clap_lex::RawArgs::new(raw);
|
||
<span class="kw">let </span><span class="kw-2">mut </span>cursor = raw.cursor();
|
||
raw.next(<span class="kw-2">&mut </span>cursor); <span class="comment">// Skip the bin
|
||
</span><span class="kw">while let </span><span class="prelude-val">Some</span>(arg) = raw.next(<span class="kw-2">&mut </span>cursor) {
|
||
<span class="kw">if </span>arg.is_escape() {
|
||
args.paths.extend(raw.remaining(<span class="kw-2">&mut </span>cursor).map(PathBuf::from));
|
||
} <span class="kw">else if </span>arg.is_stdio() {
|
||
args.paths.push(PathBuf::from(<span class="string">"-"</span>));
|
||
} <span class="kw">else if let </span><span class="prelude-val">Some</span>((long, value)) = arg.to_long() {
|
||
<span class="kw">match </span>long {
|
||
<span class="prelude-val">Ok</span>(<span class="string">"verbose"</span>) => {
|
||
<span class="kw">if let </span><span class="prelude-val">Some</span>(value) = value {
|
||
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"`--verbose` does not take a value, got `{value:?}`"</span>).into());
|
||
}
|
||
args.verbosity += <span class="number">1</span>;
|
||
}
|
||
<span class="prelude-val">Ok</span>(<span class="string">"color"</span>) => {
|
||
args.color = Color::parse(value)<span class="question-mark">?</span>;
|
||
}
|
||
<span class="kw">_ </span>=> {
|
||
<span class="kw">return </span><span class="prelude-val">Err</span>(
|
||
<span class="macro">format!</span>(<span class="string">"Unexpected flag: --{}"</span>, arg.display()).into()
|
||
);
|
||
}
|
||
}
|
||
} <span class="kw">else if let </span><span class="prelude-val">Some</span>(<span class="kw-2">mut </span>shorts) = arg.to_short() {
|
||
<span class="kw">while let </span><span class="prelude-val">Some</span>(short) = shorts.next_flag() {
|
||
<span class="kw">match </span>short {
|
||
<span class="prelude-val">Ok</span>(<span class="string">'v'</span>) => {
|
||
args.verbosity += <span class="number">1</span>;
|
||
}
|
||
<span class="prelude-val">Ok</span>(<span class="string">'c'</span>) => {
|
||
<span class="kw">let </span>value = shorts.next_value_os();
|
||
args.color = Color::parse(value)<span class="question-mark">?</span>;
|
||
}
|
||
<span class="prelude-val">Ok</span>(c) => {
|
||
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"Unexpected flag: -{c}"</span>).into());
|
||
}
|
||
<span class="prelude-val">Err</span>(e) => {
|
||
<span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"Unexpected flag: -{}"</span>, e.to_string_lossy()).into());
|
||
}
|
||
}
|
||
}
|
||
} <span class="kw">else </span>{
|
||
args.paths.push(PathBuf::from(arg.to_value_os().to_owned()));
|
||
}
|
||
}
|
||
|
||
<span class="prelude-val">Ok</span>(args)
|
||
}
|
||
|
||
<span class="kw">let </span>args = parse_args([<span class="string">"bin"</span>, <span class="string">"--hello"</span>, <span class="string">"world"</span>]);
|
||
<span class="macro">println!</span>(<span class="string">"{args:?}"</span>);</code></pre></div>
|
||
</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.ArgCursor.html" title="struct clap_lex::ArgCursor">ArgCursor</a></div><div class="desc docblock-short">Position within <a href="struct.RawArgs.html" title="struct clap_lex::RawArgs"><code>RawArgs</code></a></div></li><li><div class="item-name"><a class="struct" href="struct.ParsedArg.html" title="struct clap_lex::ParsedArg">ParsedArg</a></div><div class="desc docblock-short">Command-line Argument</div></li><li><div class="item-name"><a class="struct" href="struct.RawArgs.html" title="struct clap_lex::RawArgs">RawArgs</a></div><div class="desc docblock-short">Command-line arguments</div></li><li><div class="item-name"><a class="struct" href="struct.ShortFlags.html" title="struct clap_lex::ShortFlags">ShortFlags</a></div><div class="desc docblock-short">Walk through short flags within a <a href="struct.ParsedArg.html" title="struct clap_lex::ParsedArg"><code>ParsedArg</code></a></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.SeekFrom.html" title="enum clap_lex::SeekFrom">SeekFrom</a></div><div class="desc docblock-short">Enumeration of possible methods to seek within an I/O object.</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.OsStrExt.html" title="trait clap_lex::OsStrExt">OsStrExt</a></div></li></ul></section></div></main></body></html> |