Skip to content

Commit

Permalink
Deploying to gh-pages from @ 15adaac 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@equation314
equation314 committed Dec 22, 2024
0 parents commit 44ac2f9
Show file tree
Hide file tree
Showing 81 changed files with 3,346 additions and 0 deletions.
Empty file added .lock
Empty file.
1 change: 1 addition & 0 deletions axconfig_gen/all.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!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="List of all items in this crate"><title>List of all items in this crate</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-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="axconfig_gen" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (426d17342 2024-12-21)" data-channel="nightly" data-search-js="search-036cda7a.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.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 sys"><!--[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="../axconfig_gen/index.html">axconfig_<wbr>gen</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><h1>List of all items</h1><h3 id="structs">Structs</h3><ul class="all-items"><li><a href="struct.Config.html">Config</a></li><li><a href="struct.ConfigItem.html">ConfigItem</a></li><li><a href="struct.ConfigValue.html">ConfigValue</a></li></ul><h3 id="enums">Enums</h3><ul class="all-items"><li><a href="enum.ConfigErr.html">ConfigErr</a></li><li><a href="enum.ConfigType.html">ConfigType</a></li><li><a href="enum.OutputFormat.html">OutputFormat</a></li></ul><h3 id="types">Type Aliases</h3><ul class="all-items"><li><a href="type.ConfigResult.html">ConfigResult</a></li></ul></section></div></main></body></html>
11 changes: 11 additions & 0 deletions axconfig_gen/config/struct.Config.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../axconfig_gen/struct.Config.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../axconfig_gen/struct.Config.html">../../axconfig_gen/struct.Config.html</a>...</p>
<script>location.replace("../../axconfig_gen/struct.Config.html" + location.search + location.hash);</script>
</body>
</html>
11 changes: 11 additions & 0 deletions axconfig_gen/config/struct.ConfigItem.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../axconfig_gen/struct.ConfigItem.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../axconfig_gen/struct.ConfigItem.html">../../axconfig_gen/struct.ConfigItem.html</a>...</p>
<script>location.replace("../../axconfig_gen/struct.ConfigItem.html" + location.search + location.hash);</script>
</body>
</html>
24 changes: 24 additions & 0 deletions axconfig_gen/enum.ConfigErr.html

Large diffs are not rendered by default.

37 changes: 37 additions & 0 deletions axconfig_gen/enum.ConfigType.html

Large diffs are not rendered by default.

20 changes: 20 additions & 0 deletions axconfig_gen/enum.OutputFormat.html

Large diffs are not rendered by default.

48 changes: 48 additions & 0 deletions axconfig_gen/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!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="axconfig-gen"><title>axconfig_gen - 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-46132b98.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="axconfig_gen" data-themes="" data-resource-suffix="" data-rustdoc-version="1.85.0-nightly (426d17342 2024-12-21)" data-channel="nightly" data-search-js="search-036cda7a.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.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 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="../axconfig_gen/index.html">axconfig_<wbr>gen</a><span class="version">0.1.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 id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#axconfig-gen" title="axconfig-gen">axconfig-gen</a><ul><li><a href="#executable-usage" title="Executable Usage">Executable Usage</a></li><li><a href="#library-usage" title="Library Usage">Library Usage</a></li><li><a href="#related-libraries" title="Related libraries">Related libraries</a></li></ul></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>axconfig_gen</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/axconfig_gen/lib.rs.html#1-57">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="axconfig-gen"><a class="doc-anchor" href="#axconfig-gen">§</a>axconfig-gen</h2>
<p>A TOML-based configuration generation tool for <a href="https://github.com/arceos-org/arceos">ArceOS</a>.</p>
<h4 id="executable-usage"><a class="doc-anchor" href="#executable-usage">§</a>Executable Usage</h4><div class="example-wrap"><pre class="language-text"><code>axconfig-gen [OPTIONS] --spec &lt;SPEC&gt;

Options:
-s, --spec &lt;SPEC&gt; Path to the config specification file
-c, --oldconfig &lt;OLDCONFIG&gt; Path to the old config file
-o, --output &lt;OUTPUT&gt; Path to the output config file
-f, --fmt &lt;FMT&gt; The output format [default: toml] [possible values: toml, rust]
-w, --write &lt;CONFIG&gt; Setting a config item with format `table.key=value`
-v, --verbose Verbose mode
-h, --help Print help
-V, --version Print version</code></pre></div>
<p>For example, to generate a config file <code>.axconfig.toml</code> from the config specifications distributed in <code>a.toml</code> and <code>b.toml</code>, you can run:</p>
<div class="example-wrap"><pre class="language-sh"><code>axconfig-gen -s a.toml -s b.toml -o .axconfig.toml -f toml</code></pre></div>
<p>See <a href="https://github.com/arceos-org/axconfig-gen/blob/main/example-configs/defconfig.toml">defconfig.toml</a> for an example of a config specification file.</p>
<p>Value types are necessary for generating Rust constant definitions. Types can be specified by the comment following the config item. Currently supported types are <code>bool</code>, <code>int</code>, <code>uint</code>, <code>str</code>, <code>(type1, type2, ...)</code> for tuples, and <code>[type]</code> for arrays. If no type is specified, it will try to infer the type from the value.</p>
<h4 id="library-usage"><a class="doc-anchor" href="#library-usage">§</a>Library Usage</h4>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>axconfig_gen::{Config, OutputFormat};

<span class="kw">let </span>config_toml = <span class="string">r#"
are-you-ok = true
one-two-three = 123

[hello]
"one-two-three" = "456" # int
array = [1, 2, 3] # [uint]
tuple = [1, "abc", 3]
"#</span>;

<span class="kw">let </span>config = Config::from_toml(config_toml).unwrap();
<span class="kw">let </span>rust_code = config.dump(OutputFormat::Rust).unwrap();

<span class="macro">assert_eq!</span>(rust_code, <span class="string">r#"
pub const ARE_YOU_OK: bool = true;
pub const ONE_TWO_THREE: usize = 123;

pub mod hello {
pub const ARRAY: &amp;[usize] = &amp;[1, 2, 3];
pub const ONE_TWO_THREE: isize = 456;
pub const TUPLE: (usize, &amp;str, usize) = (1, "abc", 3);
}
"#</span>);</code></pre></div>
<h4 id="related-libraries"><a class="doc-anchor" href="#related-libraries">§</a>Related libraries</h4>
<p>There is also a procedural macro library <a href="https://docs.rs/axconfig-gen-macros"><code>axconfig-gen-macros</code></a> that can be
used to include TOML files in your project and convert them to Rust code at
compile time.</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.Config.html" title="struct axconfig_gen::Config">Config</a></div><div class="desc docblock-short">A structure storing all config items.</div></li><li><div class="item-name"><a class="struct" href="struct.ConfigItem.html" title="struct axconfig_gen::ConfigItem">Config<wbr>Item</a></div><div class="desc docblock-short">A structure representing a config item.</div></li><li><div class="item-name"><a class="struct" href="struct.ConfigValue.html" title="struct axconfig_gen::ConfigValue">Config<wbr>Value</a></div><div class="desc docblock-short">A structure representing a config value.</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.ConfigErr.html" title="enum axconfig_gen::ConfigErr">Config<wbr>Err</a></div><div class="desc docblock-short">The error type on config parsing.</div></li><li><div class="item-name"><a class="enum" href="enum.ConfigType.html" title="enum axconfig_gen::ConfigType">Config<wbr>Type</a></div><div class="desc docblock-short">The supported types in the config file.</div></li><li><div class="item-name"><a class="enum" href="enum.OutputFormat.html" title="enum axconfig_gen::OutputFormat">Output<wbr>Format</a></div><div class="desc docblock-short">The format of the generated file.</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.ConfigResult.html" title="type axconfig_gen::ConfigResult">Config<wbr>Result</a></div><div class="desc docblock-short">A specialized <a href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result"><code>Result</code></a> type with <a href="enum.ConfigErr.html" title="enum axconfig_gen::ConfigErr"><code>ConfigErr</code></a> as the error type.</div></li></ul></section></div></main></body></html>
11 changes: 11 additions & 0 deletions axconfig_gen/output/enum.OutputFormat.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=../../axconfig_gen/enum.OutputFormat.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="../../axconfig_gen/enum.OutputFormat.html">../../axconfig_gen/enum.OutputFormat.html</a>...</p>
<script>location.replace("../../axconfig_gen/enum.OutputFormat.html" + location.search + location.hash);</script>
</body>
</html>
1 change: 1 addition & 0 deletions axconfig_gen/sidebar-items.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 44ac2f9

Please sign in to comment.