Split the info examples into more.

Author: iddm

Cargo.toml

@@ -84,6 +84,14 @@ crate-type = ["cdylib"]
 name = "info_handler_macro"
 crate-type = ["cdylib"]
 
+[[example]]
+name = "info_handler_builder"
+crate-type = ["cdylib"]
+
+[[example]]
+name = "info_handler_struct"
+crate-type = ["cdylib"]
+
 [[example]]
 name = "info"
 crate-type = ["cdylib"]

examples/info_handler_builder.rs

@@ -0,0 +1,27 @@
+use redis_module::InfoContext;
+use redis_module::{redis_module, RedisResult};
+use redis_module_macros::info_command_handler;
+
+#[info_command_handler]
+fn add_info(ctx: &InfoContext, _for_crash_report: bool) -> RedisResult<()> {
+    ctx.builder()
+        .add_section("info")
+        .field("field", "value")?
+        .add_dictionary("dictionary")
+        .field("key", "value")?
+        .build_dictionary()?
+        .build_section()?
+        .build_info();
+
+    Ok(())
+}
+
+//////////////////////////////////////////////////////
+
+redis_module! {
+    name: "info_handler_builder",
+    version: 1,
+    allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
+    data_types: [],
+    commands: [],
+}

examples/info_handler_macro.rs

@@ -1,25 +1,14 @@
-use std::collections::HashMap;
-
-use redis_module::InfoContext;
 use redis_module::{redis_module, RedisResult};
+use redis_module::{InfoContext, Status};
 use redis_module_macros::info_command_handler;
-use redis_module_macros::InfoSection;
-
-#[derive(Debug, Clone, InfoSection)]
-struct InfoData {
-    field: String,
-    dictionary: HashMap<String, String>,
-}
 
 #[info_command_handler]
 fn add_info(ctx: &InfoContext, _for_crash_report: bool) -> RedisResult<()> {
-    let mut dictionary = HashMap::new();
-    dictionary.insert("key".to_owned(), "value".into());
-    let data = InfoData {
-        field: "test_helper_value".to_owned(),
-        dictionary,
-    };
-    ctx.build_one_section(data)
+    if ctx.add_info_section(Some("info")) == Status::Ok {
+        ctx.add_info_field_str("field", "value");
+    }
+
+    Ok(())
 }
 
 //////////////////////////////////////////////////////

examples/info_handler_struct.rs

@@ -0,0 +1,32 @@
+use std::collections::HashMap;
+
+use redis_module::InfoContext;
+use redis_module::{redis_module, RedisResult};
+use redis_module_macros::{info_command_handler, InfoSection};
+
+#[derive(Debug, Clone, InfoSection)]
+struct Info {
+    field: String,
+    dictionary: HashMap<String, String>,
+}
+
+#[info_command_handler]
+fn add_info(ctx: &InfoContext, _for_crash_report: bool) -> RedisResult<()> {
+    let mut dictionary = HashMap::new();
+    dictionary.insert("key".to_owned(), "value".into());
+    let data = Info {
+        field: "value".to_owned(),
+        dictionary,
+    };
+    ctx.build_one_section(data)
+}
+
+//////////////////////////////////////////////////////
+
+redis_module! {
+    name: "info_handler_struct",
+    version: 1,
+    allocator: (redis_module::alloc::RedisAlloc, redis_module::alloc::RedisAlloc),
+    data_types: [],
+    commands: [],
+}

examples/test_helper.rs

@@ -1,8 +1,7 @@
 use std::collections::HashMap;
 
-use redis_module::InfoContext;
 use redis_module::{redis_module, Context, RedisError, RedisResult, RedisString};
-use redis_module_macros::InfoSection;
+use redis_module::{InfoContext, Status};
 
 fn test_helper_version(ctx: &Context, _args: Vec<RedisString>) -> RedisResult {
     let ver = ctx.get_redis_version()?;
@@ -33,20 +32,12 @@ fn test_helper_err(ctx: &Context, args: Vec<RedisString>) -> RedisResult {
     Ok(().into())
 }
 
-#[derive(Debug, Clone, InfoSection)]
-struct InfoData {
-    field: String,
-    dictionary: HashMap<String, String>,
-}
-
 fn add_info(ctx: &InfoContext, _for_crash_report: bool) -> RedisResult<()> {
-    let mut dictionary = HashMap::new();
-    dictionary.insert("key".to_owned(), "value".into());
-    let data = InfoData {
-        field: "test_helper_value".to_owned(),
-        dictionary,
-    };
-    ctx.build_one_section(data)
+    if ctx.add_info_section(Some("test_helper")) == Status::Ok {
+        ctx.add_info_field_str("field", "value");
+    }
+
+    Ok(())
 }
 
 //////////////////////////////////////////////////////

src/context/mod.rs

@@ -1222,18 +1222,26 @@ impl InfoContext {
     }
 
     #[deprecated = "Please use [`InfoContext::builder`] instead."]
-    pub fn add_info_section(&self, name: Option<&str>) -> RedisResult<()> {
-        add_info_section(self.ctx, name).into()
+    /// The `name` of the sction will be prefixed with the module name
+    /// and an underscore: `<module name>_<name>`.
+    pub fn add_info_section(&self, name: Option<&str>) -> Status {
+        add_info_section(self.ctx, name)
     }
 
     #[deprecated = "Please use [`InfoContext::builder`] instead."]
-    pub fn add_info_field_str(&self, name: &str, content: &str) -> RedisResult<()> {
-        add_info_field_str(self.ctx, name, content).into()
+    /// The `name` will be prefixed with the module name and an
+    /// underscore: `<module name>_<name>`. The `content` pass is left
+    /// "as is".
+    pub fn add_info_field_str(&self, name: &str, content: &str) -> Status {
+        add_info_field_str(self.ctx, name, content)
     }
 
     #[deprecated = "Please use [`InfoContext::builder`] instead."]
-    pub fn add_info_field_long_long(&self, name: &str, value: c_longlong) -> RedisResult<()> {
-        add_info_field_long_long(self.ctx, name, value).into()
+    /// The `name` will be prefixed with the module name and an
+    /// underscore: `<module name>_<name>`. The `value` pass is left
+    /// "as is".
+    pub fn add_info_field_long_long(&self, name: &str, value: c_longlong) -> Status {
+        add_info_field_long_long(self.ctx, name, value)
     }
 }
 

tests/integration.rs

@@ -113,24 +113,34 @@ fn test_command_name() -> Result<()> {
 
 #[test]
 fn test_helper_info() -> Result<()> {
-    const MODULES: [&str; 2] = ["test_helper", "info_handler_macro"];
-
-    MODULES.iter().try_for_each(|module| {
-        let port: u16 = 6483;
-        let _guards = vec![start_redis_server_with_module(module, port)
-            .with_context(|| "failed to start redis server")?];
-        let mut con =
-            get_redis_connection(port).with_context(|| "failed to connect to redis server")?;
-
-        let res: String = redis::cmd("INFO")
-            .arg(module)
-            .query(&mut con)
-            .with_context(|| format!("failed to run INFO {module}"))?;
-        assert!(res.contains(&format!("{module}_field:test_helper_value")));
-        assert!(res.contains("dictionary:key=value"));
-
-        Ok(())
-    })
+    const MODULES: [(&str, bool); 4] = [
+        ("test_helper", false),
+        ("info_handler_macro", false),
+        ("info_handler_builder", true),
+        ("info_handler_struct", true),
+    ];
+
+    MODULES
+        .into_iter()
+        .try_for_each(|(module, has_dictionary)| {
+            let port: u16 = 6483;
+            let _guards = vec![start_redis_server_with_module(module, port)
+                .with_context(|| "failed to start redis server")?];
+            let mut con =
+                get_redis_connection(port).with_context(|| "failed to connect to redis server")?;
+
+            let res: String = redis::cmd("INFO")
+                .arg(module)
+                .query(&mut con)
+                .with_context(|| format!("failed to run INFO {module}"))?;
+            println!("Now processing {module}. Result: {res}.");
+            assert!(res.contains(&format!("{module}_field:value")));
+            if has_dictionary {
+                assert!(res.contains("dictionary:key=value"));
+            }
+
+            Ok(())
+        })
 }
 
 #[allow(unused_must_use)]