a29efe28f7
# Description As suggested by @WindSoilder, since plugins can now contain both simple commands that produce `Value` and commands that produce `PipelineData` without having to choose one or the other for the whole plugin, this change merges `stream_example` into `example`. # User-Facing Changes All of the example plugins are renamed. # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib` # After Submitting - [ ] Check nushell/nushell.github.io for any docs that match the command names changed
52 lines
1.7 KiB
Rust
52 lines
1.7 KiB
Rust
use nu_plugin::{EngineInterface, EvaluatedCall, LabeledError, PluginCommand};
|
|
use nu_protocol::{Category, PipelineData, PluginExample, PluginSignature, RawStream, Type, Value};
|
|
|
|
use crate::Example;
|
|
|
|
/// `<list<string>> | example collect-external`
|
|
pub struct CollectExternal;
|
|
|
|
impl PluginCommand for CollectExternal {
|
|
type Plugin = Example;
|
|
|
|
fn signature(&self) -> PluginSignature {
|
|
PluginSignature::build("example collect-external")
|
|
.usage("Example transformer to raw external stream")
|
|
.search_terms(vec!["example".into()])
|
|
.input_output_types(vec![
|
|
(Type::List(Type::String.into()), Type::String),
|
|
(Type::List(Type::Binary.into()), Type::Binary),
|
|
])
|
|
.plugin_examples(vec![PluginExample {
|
|
example: "[a b] | example collect-external".into(),
|
|
description: "collect strings into one stream".into(),
|
|
result: Some(Value::test_string("ab")),
|
|
}])
|
|
.category(Category::Experimental)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_plugin: &Example,
|
|
_engine: &EngineInterface,
|
|
call: &EvaluatedCall,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, LabeledError> {
|
|
let stream = input.into_iter().map(|value| {
|
|
value
|
|
.as_str()
|
|
.map(|str| str.as_bytes())
|
|
.or_else(|_| value.as_binary())
|
|
.map(|bin| bin.to_vec())
|
|
});
|
|
Ok(PipelineData::ExternalStream {
|
|
stdout: Some(RawStream::new(Box::new(stream), None, call.head, None)),
|
|
stderr: None,
|
|
exit_code: None,
|
|
span: call.head,
|
|
metadata: None,
|
|
trim_end_newline: false,
|
|
})
|
|
}
|
|
}
|