update docs

automation-tasks-rs · May 4, 2024 · ec3e428 · ec3e428
1 parent 7c0bfd8
commit ec3e428
Show file tree

Hide file tree

Showing 79 changed files with 455 additions and 1,039 deletions.
diff --git a/docs/cargo_auto/all.html b/docs/cargo_auto/all.html
@@ -33,7 +33,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <section>

diff --git a/docs/cargo_auto/fn.main.html b/docs/cargo_auto/fn.main.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>

diff --git a/docs/cargo_auto/index.html b/docs/cargo_auto/index.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <ul class="block">
@@ -81,7 +81,7 @@ <h1>Crate <a class="mod" href="#">cargo_auto</a><button id="copy-path" title="Co
           <div class="docblock">
             <h2 id="cargo-auto"><a class="doc-anchor" href="#cargo-auto">§</a>cargo-auto</h2>
             <p><strong>Automation tasks coded in Rust language for the workflow of Rust projects</strong><br>
-            <em><strong>version: 2024.501.1827 date: 2024-05-01 author: <a href="https://bestia.dev">bestia.dev</a> repository: <a href=
+            <em><strong>version: 2024.504.1703 date: 2024-05-04 author: <a href="https://bestia.dev">bestia.dev</a> repository: <a href=
             "https://github.com/automation-tasks-rs/cargo-auto">GitHub</a></strong></em></p>
             <p><img src="https://img.shields.io/badge/maintained-green" alt="maintained"> <img src="https://img.shields.io/badge/ready_for_use-green" alt=
             "ready-for-use"> <img src="https://img.shields.io/badge/rustlang-orange" alt="rustlang"> <img src="https://img.shields.io/badge/automation-orange"
@@ -98,13 +98,13 @@ <h2 id="cargo-auto"><a class="doc-anchor" href="#cargo-auto">§</a>cargo-auto</h
             "https://github.com/automation-tasks-rs/cargo-auto/workflows/rust_fmt_auto_build_test/badge.svg" alt="Rust"></a> <a href=
             "https://automation-tasks-rs.github.io/cargo-auto/cargo_auto/index.html"><img src="https://img.shields.io/badge/newest_docs-blue.svg" alt=
             "Newest docs"></a> <img src="https://bestia.dev/webpage_hit_counter/get_svg_image/959103982.svg" alt="cargo-auto"></p>
-            <p><a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_Rust-1299-green.svg" alt=
+            <p><a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_Rust-743-green.svg" alt=
             "Lines in Rust code"></a> <a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src=
-            "https://img.shields.io/badge/Lines_in_Doc_comments-742-blue.svg" alt="Lines in Doc comments"></a> <a href=
-            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_comments-222-purple.svg" alt=
+            "https://img.shields.io/badge/Lines_in_Doc_comments-574-blue.svg" alt="Lines in Doc comments"></a> <a href=
+            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_comments-105-purple.svg" alt=
             "Lines in Comments"></a> <a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src=
             "https://img.shields.io/badge/Lines_in_examples-0-yellow.svg" alt="Lines in examples"></a> <a href=
-            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_tests-549-orange.svg" alt=
+            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_tests-0-orange.svg" alt=
             "Lines in tests"></a></p>
             <p>Hashtags: #maintained #ready-for-use #rustlang #automation #workflow<br>
             My projects on GitHub are more like a tutorial than a finished product: <a href="https://github.com/bestia-dev/tutorials_rust_wasm">bestia-dev
@@ -130,7 +130,7 @@ <h3 id="try-it"><a class="doc-anchor" href="#try-it">§</a>Try it</h3>
             <p>We can also add <code>automation tasks</code> to an existing Rust project. Inside your Rust project directory (the one with
             <code>Cargo.toml</code>) run:</p>
             <div class="example-wrap">
-              <pre class="language-bash"><code>cargo auto new_auto
+              <pre class="language-bash"><code>cargo auto new_auto_for_cli
 cargo auto
 # it lists all the prepared automation tasks
 # try to build
@@ -212,7 +212,7 @@ <h3 id="scripting-with-rust"><a class="doc-anchor" href="#scripting-with-rust">
             This tool <code>cargo-auto</code> is meant for Rust projects, so it means that all the Rust infrastructure is already in place.</p>
             <h3 id="automation_tasks_rs-rust-sub-project"><a class="doc-anchor" href="#automation_tasks_rs-rust-sub-project">§</a>automation_tasks_rs Rust
             sub-project</h3>
-            <p>The command <code>cargo auto new_auto</code> will create a new Rust sub-project<code>automation_tasks_rs</code> inside your <code>Rust
+            <p>The command <code>cargo auto new_auto_for_cli</code> will create a new Rust sub-project<code>automation_tasks_rs</code> inside your <code>Rust
             project</code>. It should not interfere with the main Rust project. This directory will be added to git commits and pushed to remote repositories
             as part of the main project. It has its own <code>.gitignore</code> to avoid committing to its target directory.<br>
             The <code>automation_tasks_rs</code> helper project contains user-defined tasks in Rust code. Your tasks. This helper project should be opened in a

diff --git a/docs/cargo_auto_local_lib/all.html b/docs/cargo_auto_local_lib/all.html
@@ -33,7 +33,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <section>
@@ -72,9 +72,6 @@ <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span c
         <h1>List of all items</h1>
         <h3 id="structs">Structs</h3>
         <ul class="all-items">
-          <li>
-            <a href="struct.FileItem.html">FileItem</a>
-          </li>
           <li>
             <a href="struct.PATH_AUTOMATION_TASKS_RS.html">PATH_AUTOMATION_TASKS_RS</a>
           </li>
@@ -126,6 +123,14 @@ <h3 id="functions">Functions</h3>
           <li>
             <a href="inside_of_rust_project_mod/fn.already_exists_automation_tasks_rs.html">inside_of_rust_project_mod::already_exists_automation_tasks_rs</a>
           </li>
+          <li>
+            <a href=
+            "inside_of_rust_project_mod/fn.compile_automation_tasks_rs_if_needed.html">inside_of_rust_project_mod::compile_automation_tasks_rs_if_needed</a>
+          </li>
+          <li>
+            <a href=
+            "inside_of_rust_project_mod/fn.compile_project_automation_tasks_rs.html">inside_of_rust_project_mod::compile_project_automation_tasks_rs</a>
+          </li>
           <li>
             <a href="inside_of_rust_project_mod/fn.completion.html">inside_of_rust_project_mod::completion</a>
           </li>
@@ -154,19 +159,10 @@ <h3 id="functions">Functions</h3>
             <a href="outside_of_rust_project_mod/fn.print_help_from_cargo_auto.html">outside_of_rust_project_mod::print_help_from_cargo_auto</a>
           </li>
           <li>
-            <a href="template_new_auto_mod/fn.compile_automation_tasks_rs_if_needed.html">template_new_auto_mod::compile_automation_tasks_rs_if_needed</a>
-          </li>
-          <li>
-            <a href="template_new_auto_mod/fn.compile_project_automation_tasks_rs.html">template_new_auto_mod::compile_project_automation_tasks_rs</a>
-          </li>
-          <li>
-            <a href="template_new_auto_mod/fn.copy_to_files.html">template_new_auto_mod::copy_to_files</a>
-          </li>
-          <li>
-            <a href="template_new_auto_mod/fn.get_vec_file.html">template_new_auto_mod::get_vec_file</a>
+            <a href="template_new_auto_for_cli_mod/fn.copy_to_files.html">template_new_auto_for_cli_mod::copy_to_files</a>
           </li>
           <li>
-            <a href="template_new_auto_mod/fn.new_auto.html">template_new_auto_mod::new_auto</a>
+            <a href="template_new_auto_for_cli_mod/fn.new_auto_for_cli.html">template_new_auto_for_cli_mod::new_auto_for_cli</a>
           </li>
           <li>
             <a href="template_new_cli_mod/fn.copy_to_files.html">template_new_cli_mod::copy_to_files</a>

diff --git a/docs/cargo_auto_local_lib/constant.GREEN.html b/docs/cargo_auto_local_lib/constant.GREEN.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>

diff --git a/docs/cargo_auto_local_lib/constant.RED.html b/docs/cargo_auto_local_lib/constant.RED.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>

diff --git a/docs/cargo_auto_local_lib/constant.RESET.html b/docs/cargo_auto_local_lib/constant.RESET.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>

diff --git a/docs/cargo_auto_local_lib/constant.YELLOW.html b/docs/cargo_auto_local_lib/constant.YELLOW.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.are_all_files_equal.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.are_all_files_equal.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.is_project_changed.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.is_project_changed.html
@@ -35,7 +35,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.read_file_metadata.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.read_file_metadata.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.read_json_file.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.read_json_file.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.save_json_file_for_file_meta_data.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.save_json_file_for_file_meta_data.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.sha256_digest.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.sha256_digest.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/index.html b/docs/cargo_auto_local_lib/file_hashes_mod/index.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <h2 class="location"><a href="#">Module file_hashes_mod</a></h2>
     <div class="sidebar-elems">

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/struct.FileHashes.html b/docs/cargo_auto_local_lib/file_hashes_mod/struct.FileHashes.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <h2 class="location"><a href="#">FileHashes</a></h2>
     <div class="sidebar-elems">

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/struct.FileMetaData.html b/docs/cargo_auto_local_lib/file_hashes_mod/struct.FileMetaData.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <h2 class="location"><a href="#">FileMetaData</a></h2>
     <div class="sidebar-elems">

diff --git a/docs/cargo_auto_local_lib/fn.is_not_run_in_rust_project_root_directory.html b/docs/cargo_auto_local_lib/fn.is_not_run_in_rust_project_root_directory.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.504.1703</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>
@@ -59,7 +59,7 @@ <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span c
         <div class="main-heading">
           <h1>Function <a href="index.html">cargo_auto_local_lib</a>::<wbr><a class="fn" href="#">is_not_run_in_rust_project_root_directory</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/cargo_auto_local_lib/lib.rs.html#309-312">source</a> ·
+          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#303-306">source</a> ·
           <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
         </div>
         <pre class="rust item-decl"><code>pub fn is_not_run_in_rust_project_root_directory() -&gt; <a class="primitive" href=