aboutsummaryrefslogtreecommitdiff
path: root/examples/example-exitcode
diff options
context:
space:
mode:
Diffstat (limited to 'examples/example-exitcode')
-rw-r--r--examples/example-exitcode/Cargo.lock76
-rw-r--r--examples/example-exitcode/Cargo.toml7
-rw-r--r--examples/example-exitcode/src/main.rs62
3 files changed, 145 insertions, 0 deletions
diff --git a/examples/example-exitcode/Cargo.lock b/examples/example-exitcode/Cargo.lock
new file mode 100644
index 0000000..19f60a6
--- /dev/null
+++ b/examples/example-exitcode/Cargo.lock
@@ -0,0 +1,76 @@
+# This file is automatically @generated by Cargo.
+# It is not intended for manual editing.
+version = 4
+
+[[package]]
+name = "example-exitcode"
+version = "0.1.0"
+dependencies = [
+ "mingling",
+]
+
+[[package]]
+name = "just_fmt"
+version = "0.1.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "5454cda0d57db59778608d7a47bff5b16c6705598265869fb052b657f66cf05e"
+
+[[package]]
+name = "mingling"
+version = "0.1.9"
+dependencies = [
+ "mingling_core",
+ "mingling_macros",
+]
+
+[[package]]
+name = "mingling_core"
+version = "0.1.9"
+dependencies = [
+ "just_fmt",
+]
+
+[[package]]
+name = "mingling_macros"
+version = "0.1.9"
+dependencies = [
+ "just_fmt",
+ "proc-macro2",
+ "quote",
+ "syn",
+]
+
+[[package]]
+name = "proc-macro2"
+version = "1.0.106"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+dependencies = [
+ "unicode-ident",
+]
+
+[[package]]
+name = "quote"
+version = "1.0.45"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+dependencies = [
+ "proc-macro2",
+]
+
+[[package]]
+name = "syn"
+version = "2.0.117"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+dependencies = [
+ "proc-macro2",
+ "quote",
+ "unicode-ident",
+]
+
+[[package]]
+name = "unicode-ident"
+version = "1.0.24"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "e6e4313cd5fcd3dad5cafa179702e2b244f760991f45397d14d4ebf38247da75"
diff --git a/examples/example-exitcode/Cargo.toml b/examples/example-exitcode/Cargo.toml
new file mode 100644
index 0000000..58c800b
--- /dev/null
+++ b/examples/example-exitcode/Cargo.toml
@@ -0,0 +1,7 @@
+[package]
+name = "example-exitcode"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+mingling = { path = "../../mingling" }
diff --git a/examples/example-exitcode/src/main.rs b/examples/example-exitcode/src/main.rs
new file mode 100644
index 0000000..178fa78
--- /dev/null
+++ b/examples/example-exitcode/src/main.rs
@@ -0,0 +1,62 @@
+//! Example Error Handling
+//!
+//! > This example demonstrates how to handle errors in Mingling, including custom error types and error rendering.
+//!
+//! Run:
+//! ```bash
+//! cargo run --manifest-path examples/example-exitcode/Cargo.toml --quiet -- hello Alice
+//! cargo run --manifest-path examples/example-exitcode/Cargo.toml --quiet -- hello
+//! ```
+//!
+//! Output:
+//! ```plaintext
+//! Hello, Alice
+//! No name provided (with exit code 1)
+//! ```
+
+use mingling::{prelude::*, res::ExitCode, setup::ExitCodeSetup};
+
+fn main() {
+ let mut program = ThisProgram::new();
+
+ // --------- IMPORTANT ---------
+ // Register `ExitCodeSetup` for the program to enable exit codes
+ program.with_setup(ExitCodeSetup::default());
+ // --------- IMPORTANT ---------
+
+ program.with_dispatcher(CMDHello);
+ program.exec_and_exit();
+}
+
+dispatcher!("hello", CMDHello => EntryHello);
+
+pack!(ErrorNoNameProvided = ());
+pack!(ResultName = String);
+
+#[chain]
+fn handle_hello(args: EntryHello) -> Next {
+ let Some(name) = args.inner.first().cloned() else {
+ // If no name is provided, pass ErrorNoNameProvided
+ return ErrorNoNameProvided::default().to_render();
+ };
+
+ // If the name is valid, pass ResultName
+ ResultName::new(name).to_render()
+}
+
+#[renderer]
+fn render_result_name(name: ResultName) {
+ r_println!("Hello, {}", *name);
+}
+
+// Define renderer, render error message _____________ Inject exit code resource
+// /
+#[renderer] // vvvvvvvvvvvvv
+fn render_error_no_name_provided(_: ErrorNoNameProvided, ec: &mut ExitCode) {
+ ec.exit_code = 1;
+
+ // Prompt when no name is provided
+ r_println!("No name provided (with exit code 1)");
+}
+
+gen_program!();