Basic help for registry, --show-X

Author: AmlingPalantir

aggregator/src/array.rs

@@ -17,6 +17,14 @@ impl AggregatorBe for ImplBe {
         return vec!["array", "arr"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "collect values into an array";
+    }
+
     fn add(state: &mut Vec<Record>, a: &Arc<str>, r: Record) {
         state.push(r.get_path(a));
     }

aggregator/src/average.rs

@@ -17,6 +17,14 @@ impl AggregatorBe for ImplBe {
         return vec!["average", "avg"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "compute average of numeric values";
+    }
+
     fn add(state: &mut (f64, f64), a: &Arc<str>, r: Record) {
         let v = r.get_path(a);
         let v = v.coerce_f64();

aggregator/src/concat.rs

@@ -17,6 +17,14 @@ impl AggregatorBe for ImplBe {
         return vec!["concatenate", "concat"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("delim,key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "collect values into a string joined by a delimter";
+    }
+
     fn add(state: &mut Vec<String>, a: &(Arc<str>, Arc<str>), r: Record) {
         state.push(r.get_path(&a.1).expect_string().to_string());
     }

aggregator/src/count.rs

@@ -15,6 +15,10 @@ impl AggregatorBe for ImplBe {
         return vec!["count", "ct"];
     }
 
+    fn help_msg() -> &'static str {
+        return "count records";
+    }
+
     fn add(state: &mut i64, _a: &(), _r: Record) {
         *state += 1;
     }

aggregator/src/count_by.rs

@@ -18,6 +18,14 @@ impl AggregatorBe for ImplBe {
         return vec!["countby", "ctby", "cb"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "collect counts of values into a hash";
+    }
+
     fn add(state: &mut HashMap<Arc<str>, i64>, a: &Arc<str>, r: Record) {
         *state.entry(r.get_path(a).expect_string()).or_insert(0) += 1;
     }

aggregator/src/distinct_array.rs

@@ -51,6 +51,14 @@ impl AggregatorBe for ImplBe {
         return vec!["darray", "darr"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "collect distinct values into an array";
+    }
+
     fn add(state: &mut DistinctSet<Record>, a: &Arc<str>, r: Record) {
         state.add(r.get_path(&a));
     }

aggregator/src/distinct_concat.rs

@@ -18,6 +18,14 @@ impl AggregatorBe for ImplBe {
         return vec!["dconcatenate", "dconcat"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "collect distinct values into a string joined by a delimter";
+    }
+
     fn add(state: &mut DistinctSet<String>, a: &(Arc<str>, Arc<str>), r: Record) {
         state.add(r.get_path(&a.1).expect_string().to_string());
     }

aggregator/src/distinct_count.rs

@@ -17,6 +17,14 @@ impl AggregatorBe for ImplBe {
         return vec!["dcount", "dct"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "count distinct values";
+    }
+
     fn add(state: &mut DistinctSet<Record>, a: &Arc<str>, r: Record) {
         state.add(r.get_path(&a));
     }

aggregator/src/first.rs

@@ -16,6 +16,14 @@ impl AggregatorBe for ImplBe {
         return vec!["first"];
     }
 
+    fn help_meta() -> Option<&'static str> {
+        return Some("key");
+    }
+
+    fn help_msg() -> &'static str {
+        return "track the first value";
+    }
+
     fn add(state: &mut Option<Record>, a: &Arc<str>, r: Record) {
         state.get_or_insert(r.get_path(a));
     }

aggregator/src/first_record.rs

@@ -15,6 +15,10 @@ impl AggregatorBe for ImplBe {
         return vec!["firstrecord", "firstrec"];
     }
 
+    fn help_msg() -> &'static str {
+        return "track first record";
+    }
+
     fn add(state: &mut Option<Record>, _a: &(), r: Record) {
         state.get_or_insert(r);
     }