mirror of
https://github.com/nushell/nushell.git
synced 2025-06-09 03:26:58 +02:00
31 lines
1.6 KiB
Rust
31 lines
1.6 KiB
Rust
use nu_plugin::{MsgPackSerializer, serve_plugin};
|
|
use nu_plugin_example::ExamplePlugin;
|
|
|
|
fn main() {
|
|
// When defining your plugin, you can select the Serializer that could be
|
|
// used to encode and decode the messages. The available options are
|
|
// MsgPackSerializer and JsonSerializer. Both are defined in the serializer
|
|
// folder in nu-plugin.
|
|
serve_plugin(&ExamplePlugin {}, MsgPackSerializer {})
|
|
|
|
// Note
|
|
// When creating plugins in other languages one needs to consider how a plugin
|
|
// is added and used in nushell.
|
|
// The steps are:
|
|
// - The plugin is register. In this stage nushell calls the binary file of
|
|
// the plugin sending information using the encoded PluginCall::PluginSignature object.
|
|
// Use this encoded data in your plugin to design the logic that will return
|
|
// the encoded signatures.
|
|
// Nushell is expecting and encoded PluginResponse::PluginSignature with all the
|
|
// plugin signatures
|
|
// - When calling the plugin, nushell sends to the binary file the encoded
|
|
// PluginCall::CallInfo which has all the call information, such as the
|
|
// values of the arguments, the name of the signature called and the input
|
|
// from the pipeline.
|
|
// Use this data to design your plugin login and to create the value that
|
|
// will be sent to nushell
|
|
// Nushell expects an encoded PluginResponse::Value from the plugin
|
|
// - If an error needs to be sent back to nushell, one can encode PluginResponse::Error.
|
|
// This is a labeled error that nushell can format for pretty printing
|
|
}
|