From 1991c9f5eb7ed12ec908a53dcaf11a27c9482b69 Mon Sep 17 00:00:00 2001 From: Cain <75994858+cainthebest@users.noreply.github.com> Date: Thu, 18 Jan 2024 17:48:11 +0000 Subject: [PATCH] chore: add missing cli fn docs --- crates/cli/src/main.rs | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/crates/cli/src/main.rs b/crates/cli/src/main.rs index 1201674..5185c76 100644 --- a/crates/cli/src/main.rs +++ b/crates/cli/src/main.rs @@ -150,7 +150,6 @@ fn resolve_ip_or_domain>(host: T, extra_options: &mut Option(result: T) { println!("{}", serde_json::to_string(&result).unwrap()); } +/// Output the result as a pretty printed JSON object. +/// +/// # Arguments +/// * `result` - A serde serializable result. #[cfg(feature = "json")] fn output_result_json_pretty(result: T) { println!("{}", serde_json::to_string_pretty(&result).unwrap()); @@ -261,6 +264,10 @@ fn output_result_xml(result: T) { println!("{}", serde_xml_rs::to_string(&result).unwrap()); } +/// Output the result as a BSON object encoded as a hex string. +/// +/// # Arguments +/// * `result` - A serde serializable result. #[cfg(feature = "bson")] fn output_result_bson_hex(result: T) { let bson = bson::to_bson(&result).unwrap(); @@ -274,6 +281,10 @@ fn output_result_bson_hex(result: T) { } } +/// Output the result as a BSON object encoded as a base64 string. +/// +/// # Arguments +/// * `result` - A serde serializable result. #[cfg(feature = "bson")] fn output_result_bson_base64(result: T) { use base64::Engine;