Deploy site + cookbook: Merge pull request #106 from Tuntii/update-docs-v0.1.300-9259717141717722755

Update Cookbook Documentation for v0.1.300 44b8d64

Author: Tuntii

cookbook/404.html

@@ -37,7 +37,7 @@
             const path_to_root = "";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="toc-54f2b124.js"></script>

cookbook/architecture/system_overview.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/concepts/handlers.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/concepts/index.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/concepts/performance.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/concepts/testing.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/crates/cargo_rustapi.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/crates/index.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/crates/rustapi_core.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>

cookbook/crates/rustapi_extras.html

@@ -36,7 +36,7 @@
             const path_to_root = "../";
             const default_light_theme = "light";
             const default_dark_theme = "navy";
-            window.path_to_searchindex_js = "../searchindex-6cf81054.js";
+            window.path_to_searchindex_js = "../searchindex-26942635.js";
         </script>
         <!-- Start loading toc.js asap -->
         <script src="../toc-54f2b124.js"></script>
@@ -198,6 +198,10 @@ <h2 id="feature-flags"><a class="header" href="#feature-flags">Feature Flags</a>
 <tr><td><code>audit</code></td><td><code>AuditStore</code>, <code>AuditLogger</code></td></tr>
 <tr><td><code>insight</code></td><td><code>InsightLayer</code>, <code>InsightStore</code></td></tr>
 <tr><td><code>rate-limit</code></td><td><code>RateLimitLayer</code></td></tr>
+<tr><td><code>replay</code></td><td><code>ReplayLayer</code> (Time-Travel Debugging)</td></tr>
+<tr><td><code>timeout</code></td><td><code>TimeoutLayer</code></td></tr>
+<tr><td><code>guard</code></td><td><code>PermissionGuard</code></td></tr>
+<tr><td><code>sanitization</code></td><td>Input sanitization utilities</td></tr>
 </tbody>
 </table>
 </div>
@@ -299,7 +303,7 @@ <h3 id="opentelemetry"><a class="header" href="#opentelemetry">OpenTelemetry</a>
     .layer(OtelLayer::new(config));
 <span class="boring">}</span></code></pre>
 <h3 id="structured-logging"><a class="header" href="#structured-logging">Structured Logging</a></h3>
-<p>Emit logs as JSON for aggregators like Datadog or Splunk.</p>
+<p>Emit logs as JSON for aggregators like Datadog or Splunk. This is different from request logging; it formats your application logs.</p>
 <pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
 </span><span class="boring">fn main() {
 </span>use rustapi_extras::structured_logging::{StructuredLoggingLayer, JsonFormatter};
@@ -340,6 +344,29 @@ <h3 id="api-keys"><a class="header" href="#api-keys">API Keys</a></h3>
 let app = RustApi::new()
     .layer(ApiKeyLayer::new("my-secret-key"));
 <span class="boring">}</span></code></pre>
+<h3 id="permission-guards"><a class="header" href="#permission-guards">Permission Guards</a></h3>
+<p>The <code>guard</code> feature provides role-based access control (RBAC) helpers.</p>
+<pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
+</span><span class="boring">fn main() {
+</span>use rustapi_extras::guard::PermissionGuard;
+
+// Only allows users with "admin" role
+#[rustapi_rs::get("/admin")]
+async fn admin_panel(
+    _guard: PermissionGuard
+) -&gt; &amp;'static str {
+    "Welcome Admin"
+}
+<span class="boring">}</span></code></pre>
+<h3 id="input-sanitization"><a class="header" href="#input-sanitization">Input Sanitization</a></h3>
+<p>The <code>sanitization</code> feature helps prevent XSS by cleaning user input.</p>
+<pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
+</span><span class="boring">fn main() {
+</span>use rustapi_extras::sanitization::sanitize_html;
+
+let safe_html = sanitize_html("&lt;script&gt;alert(1)&lt;/script&gt;Hello");
+// Result: "&amp;lt;script&amp;gt;alert(1)&amp;lt;/script&amp;gt;Hello"
+<span class="boring">}</span></code></pre>
 <h2 id="resilience"><a class="header" href="#resilience">Resilience</a></h2>
 <h3 id="circuit-breaker"><a class="header" href="#circuit-breaker">Circuit Breaker</a></h3>
 <p>Prevent cascading failures by stopping requests to failing upstreams.</p>
@@ -359,6 +386,16 @@ <h3 id="retry"><a class="header" href="#retry">Retry</a></h3>
 let app = RustApi::new()
     .layer(RetryLayer::default());
 <span class="boring">}</span></code></pre>
+<h3 id="timeout"><a class="header" href="#timeout">Timeout</a></h3>
+<p>Ensure requests don’t hang indefinitely.</p>
+<pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
+</span><span class="boring">fn main() {
+</span>use rustapi_extras::timeout::TimeoutLayer;
+use std::time::Duration;
+
+let app = RustApi::new()
+    .layer(TimeoutLayer::new(Duration::from_secs(30)));
+<span class="boring">}</span></code></pre>
 <h2 id="optimization"><a class="header" href="#optimization">Optimization</a></h2>
 <h3 id="caching"><a class="header" href="#caching">Caching</a></h3>
 <p>Cache responses based on headers or path.</p>
@@ -378,6 +415,20 @@ <h3 id="request-deduplication"><a class="header" href="#request-deduplication">R
 let app = RustApi::new()
     .layer(DedupLayer::new());
 <span class="boring">}</span></code></pre>
+<h2 id="debugging"><a class="header" href="#debugging">Debugging</a></h2>
+<h3 id="time-travel-debugging-replay"><a class="header" href="#time-travel-debugging-replay">Time-Travel Debugging (Replay)</a></h3>
+<p>The <code>replay</code> feature allows you to record production traffic and replay it locally for debugging.</p>
+<p>See the <a href="../recipes/replay.html">Time-Travel Debugging Recipe</a> for full details.</p>
+<pre class="playground"><code class="language-rust"><span class="boring">#![allow(unused)]
+</span><span class="boring">fn main() {
+</span>use rustapi_extras::replay::{ReplayLayer, ReplayConfig, InMemoryReplayStore};
+
+let replay_config = ReplayConfig::default();
+let store = InMemoryReplayStore::new(1_000);
+
+let app = RustApi::new()
+    .layer(ReplayLayer::new(replay_config).with_store(store));
+<span class="boring">}</span></code></pre>
 
                     </main>