forked from extern/nushell
95b78eee25
# Description
The meaning of the word usage is specific to describing how a command
function is *used* and not a synonym for general description. Usage can
be used to describe the SYNOPSIS or EXAMPLES sections of a man page
where the permitted argument combinations are shown or example *uses*
are given.
Let's not confuse people and call it what it is a description.
Our `help` command already creates its own *Usage* section based on the
available arguments and doesn't refer to the description with usage.
# User-Facing Changes
`help commands` and `scope commands` will now use `description` or
`extra_description`
`usage`-> `description`
`extra_usage` -> `extra_description`
Breaking change in the plugin protocol:
In the signature record communicated with the engine.
`usage`-> `description`
`extra_usage` -> `extra_description`
The same rename also takes place for the methods on
`SimplePluginCommand` and `PluginCommand`
# Tests + Formatting
- Updated plugin protocol specific changes
# After Submitting
- [ ] update plugin protocol doc
65 lines
1.4 KiB
Rust
65 lines
1.4 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
use rand::{thread_rng, RngCore};
|
|
|
|
#[derive(Clone)]
|
|
pub struct SubCommand;
|
|
|
|
impl Command for SubCommand {
|
|
fn name(&self) -> &str {
|
|
"random binary"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("random binary")
|
|
.input_output_types(vec![(Type::Nothing, Type::Binary)])
|
|
.allow_variants_without_examples(true)
|
|
.required("length", SyntaxShape::Int, "Length of the output binary.")
|
|
.category(Category::Random)
|
|
}
|
|
|
|
fn description(&self) -> &str {
|
|
"Generate random bytes."
|
|
}
|
|
|
|
fn search_terms(&self) -> Vec<&str> {
|
|
vec!["generate", "bytes"]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let length = call.req(engine_state, stack, 0)?;
|
|
let mut rng = thread_rng();
|
|
|
|
let mut out = vec![0u8; length];
|
|
rng.fill_bytes(&mut out);
|
|
|
|
Ok(Value::binary(out, call.head).into_pipeline_data())
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Generate 16 random bytes",
|
|
example: "random binary 16",
|
|
result: None,
|
|
}]
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
use crate::test_examples;
|
|
|
|
test_examples(SubCommand {})
|
|
}
|
|
}
|