mirror of
https://github.com/nushell/nushell
synced 2025-01-14 06:04:09 +00:00
0c4d5330ee
# Description This breaks `nu-plugin` up into four crates: - `nu-plugin-protocol`: just the type definitions for the protocol, no I/O. If someone wanted to wire up something more bare metal, maybe for async I/O, they could use this. - `nu-plugin-core`: the shared stuff between engine/plugin. Less stable interface. - `nu-plugin-engine`: everything required for the engine to talk to plugins. Less stable interface. - `nu-plugin`: everything required for the plugin to talk to the engine, what plugin developers use. Should be the most stable interface. No changes are made to the interface exposed by `nu-plugin` - it should all still be there. Re-exports from `nu-plugin-protocol` or `nu-plugin-core` are used as required. Plugins shouldn't ever have to use those crates directly. This should be somewhat faster to compile as `nu-plugin-engine` and `nu-plugin` can compile in parallel, and the engine doesn't need `nu-plugin` and plugins don't need `nu-plugin-engine` (except for test support), so that should reduce what needs to be compiled too. The only significant change here other than splitting stuff up was to break the `source` out of `PluginCustomValue` and create a new `PluginCustomValueWithSource` type that contains that instead. One bonus of that is we get rid of the option and it's now more type-safe, but it also means that the logic for that stuff (actually running the plugin for custom value ops) can live entirely within the `nu-plugin-engine` crate. # User-Facing Changes - New crates. - Added `local-socket` feature for `nu` to try to make it possible to compile without that support if needed. # Tests + Formatting - 🟢 `toolkit fmt` - 🟢 `toolkit clippy` - 🟢 `toolkit test` - 🟢 `toolkit test stdlib`
24 lines
862 B
Rust
24 lines
862 B
Rust
//! Functionality and types shared between the plugin and the engine, other than protocol types.
|
|
//!
|
|
//! If you are writing a plugin, you probably don't need this crate. We will make fewer guarantees
|
|
//! for the stability of the interface of this crate than for `nu_plugin`.
|
|
|
|
pub mod util;
|
|
|
|
mod communication_mode;
|
|
mod interface;
|
|
mod serializers;
|
|
|
|
pub use communication_mode::{
|
|
ClientCommunicationIo, CommunicationMode, PreparedServerCommunication, ServerCommunicationIo,
|
|
};
|
|
pub use interface::{
|
|
stream::{FromShellError, StreamManager, StreamManagerHandle, StreamReader, StreamWriter},
|
|
Interface, InterfaceManager, PipelineDataWriter, PluginRead, PluginWrite,
|
|
};
|
|
pub use serializers::{
|
|
json::JsonSerializer, msgpack::MsgPackSerializer, Encoder, EncodingType, PluginEncoder,
|
|
};
|
|
|
|
#[doc(hidden)]
|
|
pub use interface::test_util as interface_test_util;
|