aboutsummaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
author魏曹先生 <1992414357@qq.com>2026-06-26 06:27:16 +0800
committer魏曹先生 <1992414357@qq.com>2026-06-26 06:41:01 +0800
commitd1a74ce57e5be72436376a829e9c7e1e7c1c561b (patch)
tree6ac923671fc09f1c47b613869d793ed3e04b91db /examples
parente735671acb3a81e1b7e334e56b9ef3963ba0c2fc (diff)
refactor(general_renderer): rename to structural_renderer
Diffstat (limited to 'examples')
-rw-r--r--examples/example-general-renderer/page.toml10
-rw-r--r--examples/example-pack-err/Cargo.toml2
-rw-r--r--examples/example-pack-err/page.toml4
-rw-r--r--examples/example-pack-err/src/main.rs10
-rw-r--r--examples/example-structural-renderer/Cargo.lock (renamed from examples/example-general-renderer/Cargo.lock)14
-rw-r--r--examples/example-structural-renderer/Cargo.toml (renamed from examples/example-general-renderer/Cargo.toml)4
-rw-r--r--examples/example-structural-renderer/page.toml10
-rw-r--r--examples/example-structural-renderer/src/main.rs (renamed from examples/example-general-renderer/src/main.rs)18
-rw-r--r--examples/full-todolist/Cargo.toml2
-rw-r--r--examples/full-todolist/src/main.rs4
-rw-r--r--examples/test-examples.toml4
11 files changed, 41 insertions, 41 deletions
diff --git a/examples/example-general-renderer/page.toml b/examples/example-general-renderer/page.toml
deleted file mode 100644
index 1d3e4b1..0000000
--- a/examples/example-general-renderer/page.toml
+++ /dev/null
@@ -1,10 +0,0 @@
-[example]
-id = "example-general-renderer"
-name = "General Renderer"
-icon = "📤"
-category = "output"
-desc = """
-Demonstrates how to render structured output in JSON or YAML using `GeneralRendererSetup` and the `general_renderer` feature.
-"""
-tags = ["general_renderer", "--json", "--yaml"]
-files = ["src/main.rs", "Cargo.toml"]
diff --git a/examples/example-pack-err/Cargo.toml b/examples/example-pack-err/Cargo.toml
index 883fc89..5d61319 100644
--- a/examples/example-pack-err/Cargo.toml
+++ b/examples/example-pack-err/Cargo.toml
@@ -9,7 +9,7 @@ serde = { version = "1.0.228", features = ["derive"] }
[dependencies.mingling]
path = "../../mingling"
features = [
- "general_renderer",
+ "structural_renderer",
"extra_macros",
]
diff --git a/examples/example-pack-err/page.toml b/examples/example-pack-err/page.toml
index 255bbdd..37f2c31 100644
--- a/examples/example-pack-err/page.toml
+++ b/examples/example-pack-err/page.toml
@@ -4,7 +4,7 @@ name = "Pack an Error"
icon = "🛑"
category = "macros"
desc = """
-Demonstrates how to use the `pack_err!` macro to define error types with automatic `name` field (snake_case at compile time) and optional `info` field. Also shows `--json` serialization when `general_renderer` is enabled.
+Demonstrates how to use the `pack_err!` macro to define error types with automatic `name` field (snake_case at compile time) and optional `info` field. Also shows `--json` serialization when `structural_renderer` is enabled.
"""
-tags = ["pack_err!", "extra_macros", "general_renderer", "--json"]
+tags = ["pack_err!", "extra_macros", "structural_renderer", "--json"]
files = ["src/main.rs", "Cargo.toml"]
diff --git a/examples/example-pack-err/src/main.rs b/examples/example-pack-err/src/main.rs
index f859fae..8716333 100644
--- a/examples/example-pack-err/src/main.rs
+++ b/examples/example-pack-err/src/main.rs
@@ -2,7 +2,7 @@
//!
//! > This example demonstrates how to use the `pack_err!` macro to define error types
//! > with automatic `name` field (set to snake_case at compile time) and optional `info` field.
-//! > Also demonstrates `--json` serialization when `general_renderer` is enabled.
+//! > Also demonstrates `--json` serialization when `structural_renderer` is enabled.
//!
//! Run:
//! ```bash
@@ -27,7 +27,7 @@
//! ```
use mingling::prelude::*;
-use mingling::setup::GeneralRendererSetup;
+use mingling::setup::StructuralRendererSetup;
use std::path::PathBuf;
dispatcher!("find", CMDFind => EntryFind);
@@ -45,7 +45,7 @@ dispatcher!("find-structural", CMDFindStructural => EntryFindStructural);
// The typed form additionally generates `pub fn new(info)`.
// name = "error_not_dir"
//
-// When `general_renderer` is enabled, the struct also gets
+// When `structural_renderer` is enabled, the struct also gets
// `#[derive(serde::Serialize)]` for --json / --yaml output.
// --------- IMPORTANT ---------
@@ -132,8 +132,8 @@ gen_program!();
fn main() {
let mut program = ThisProgram::new();
- // Add GeneralRendererSetup to support --json / --yaml flags
- program.with_setup(GeneralRendererSetup);
+ // Add StructuralRendererSetup to support --json / --yaml flags
+ program.with_setup(StructuralRendererSetup);
program.with_dispatcher(CMDFind);
program.with_dispatcher(CMDFindStructural);
let _ = program.exec();
diff --git a/examples/example-general-renderer/Cargo.lock b/examples/example-structural-renderer/Cargo.lock
index 0919b7d..cee5ae3 100644
--- a/examples/example-general-renderer/Cargo.lock
+++ b/examples/example-structural-renderer/Cargo.lock
@@ -3,7 +3,7 @@
version = 4
[[package]]
-name = "example-general-renderer"
+name = "example-structural-renderer"
version = "0.1.0"
dependencies = [
"mingling",
@@ -24,9 +24,9 @@ checksum = "5454cda0d57db59778608d7a47bff5b16c6705598265869fb052b657f66cf05e"
[[package]]
name = "memchr"
-version = "2.8.0"
+version = "2.8.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f8ca58f447f06ed17d5fc4043ce1b10dd205e060fb3ce5b979b8ed8e59ff3f79"
+checksum = "88904434abc2901f197fe8cc55f0445e7ded921dba5911dad2e2b39b48e663c4"
[[package]]
name = "mingling"
@@ -68,9 +68,9 @@ dependencies = [
[[package]]
name = "quote"
-version = "1.0.45"
+version = "1.0.46"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "41f2619966050689382d2b44f664f4bc593e129785a36d6ee376ddf37259b924"
+checksum = "dfbc457d0c7a0759a614551b11a6409e5951f6c7537be1f1b7682b9ae9230368"
dependencies = [
"proc-macro2",
]
@@ -126,9 +126,9 @@ checksum = "1b6709c7b6754dca1311b3c73e79fcce40dd414c782c66d88e8823030093b02b"
[[package]]
name = "syn"
-version = "2.0.117"
+version = "2.0.118"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e665b8803e7b1d2a727f4023456bbbbe74da67099c585258af0ad9c5013b9b99"
+checksum = "1b9ae57f904213ebb649ce6895b8a66c66f0203b9319718f69a5612a065b1422"
dependencies = [
"proc-macro2",
"quote",
diff --git a/examples/example-general-renderer/Cargo.toml b/examples/example-structural-renderer/Cargo.toml
index fd7879b..2090166 100644
--- a/examples/example-general-renderer/Cargo.toml
+++ b/examples/example-structural-renderer/Cargo.toml
@@ -1,5 +1,5 @@
[package]
-name = "example-general-renderer"
+name = "example-structural-renderer"
version = "0.1.0"
edition = "2024"
@@ -9,7 +9,7 @@ serde = { version = "1.0.228", features = ["derive"] }
[dependencies.mingling]
path = "../../mingling"
features = [
- "general_renderer",
+ "structural_renderer",
"parser",
]
diff --git a/examples/example-structural-renderer/page.toml b/examples/example-structural-renderer/page.toml
new file mode 100644
index 0000000..0ed7745
--- /dev/null
+++ b/examples/example-structural-renderer/page.toml
@@ -0,0 +1,10 @@
+[example]
+id = "example-structural-renderer"
+name = "structural renderer"
+icon = "📤"
+category = "output"
+desc = """
+Demonstrates how to render structured output in JSON or YAML using `StructuralRendererSetup` and the `structural_renderer` feature.
+"""
+tags = ["structural_renderer", "--json", "--yaml"]
+files = ["src/main.rs", "Cargo.toml"]
diff --git a/examples/example-general-renderer/src/main.rs b/examples/example-structural-renderer/src/main.rs
index 1e02afb..21077e7 100644
--- a/examples/example-general-renderer/src/main.rs
+++ b/examples/example-structural-renderer/src/main.rs
@@ -1,12 +1,12 @@
-//! Example General Renderer
+//! Example structural renderer
//!
-//! > This example demonstrates how to use the `general_renderer` feature to render data into structures such as json / yaml
+//! > This example demonstrates how to use the `structural_renderer` feature to render data into structures such as json / yaml
//!
//! Run
//! ```bash
-//! cargo run --manifest-path examples/example-general-renderer/Cargo.toml --quiet -- render Bob 22
-//! cargo run --manifest-path examples/example-general-renderer/Cargo.toml --quiet -- render Bob 22 --json
-//! cargo run --manifest-path examples/example-general-renderer/Cargo.toml --quiet -- render Bob 22 --yaml
+//! cargo run --manifest-path examples/example-structural-renderer/Cargo.toml --quiet -- render Bob 22
+//! cargo run --manifest-path examples/example-structural-renderer/Cargo.toml --quiet -- render Bob 22 --json
+//! cargo run --manifest-path examples/example-structural-renderer/Cargo.toml --quiet -- render Bob 22 --yaml
//! ```
//!
//! Output:
@@ -18,15 +18,15 @@
//! ```
use mingling::prelude::*;
-use mingling::{parser::Picker, setup::GeneralRendererSetup, StructuralData, Groupped};
+use mingling::{parser::Picker, setup::StructuralRendererSetup, StructuralData, Groupped};
use serde::Serialize;
dispatcher!("render", CMDRender => EntryRender);
fn main() {
let mut program = ThisProgram::new();
- // Add `GeneralRendererSetup` to receive user input `--json` `--yaml` parameters
- program.with_setup(GeneralRendererSetup);
+ // Add `StructuralRendererSetup` to receive user input `--json` `--yaml` parameters
+ program.with_setup(StructuralRendererSetup);
program.with_dispatcher(CMDRender);
let _ = program.exec();
}
@@ -62,7 +62,7 @@ fn parse_render(prev: EntryRender) -> Next {
Info { name, age }.to_render()
}
-/// Implement default renderer for when general_renderer is not specified
+/// Implement default renderer for when structural_renderer is not specified
#[renderer]
fn render_info(prev: Info) {
r_println!("{} is {} years old", prev.name, prev.age);
diff --git a/examples/full-todolist/Cargo.toml b/examples/full-todolist/Cargo.toml
index 50b11a5..e10f0e7 100644
--- a/examples/full-todolist/Cargo.toml
+++ b/examples/full-todolist/Cargo.toml
@@ -12,7 +12,7 @@ path = "../../mingling"
features = [
"parser",
"extra_macros",
- "general_renderer",
+ "structural_renderer",
]
[workspace]
diff --git a/examples/full-todolist/src/main.rs b/examples/full-todolist/src/main.rs
index 7f958d4..e4c5aa6 100644
--- a/examples/full-todolist/src/main.rs
+++ b/examples/full-todolist/src/main.rs
@@ -10,7 +10,7 @@ use mingling::{
macros::route,
prelude::*,
res::ResExitCode,
- setup::{ExitCodeSetup, GeneralRendererSetup, HelpFlagSetup},
+ setup::{ExitCodeSetup, StructuralRendererSetup, HelpFlagSetup},
LazyInit, LazyRes,
};
@@ -49,7 +49,7 @@ fn main() {
// Setups
program.with_setup(ExitCodeSetup::default());
- program.with_setup(GeneralRendererSetup);
+ program.with_setup(StructuralRendererSetup);
program.with_setup(HelpFlagSetup::new(["--help", "-h"]));
// Flags
diff --git a/examples/test-examples.toml b/examples/test-examples.toml
index 149f2c6..b4cbb6d 100644
--- a/examples/test-examples.toml
+++ b/examples/test-examples.toml
@@ -138,12 +138,12 @@ command = "lang-select OCaml"
expect.exit-code = 0
expect.result = "Selected: OCaml"
-[[test.example-general-renderer]]
+[[test.example-structural-renderer]]
command = "render Bob 22"
expect.exit-code = 0
expect.result = "Bob is 22 years old"
-[[test.example-general-renderer]]
+[[test.example-structural-renderer]]
command = "render Bob 22 --json"
expect.exit-code = 0
expect.result = "{\"member_name\":\"Bob\",\"member_age\":22}"