mirror of
https://github.com/nushell/nushell.git
synced 2025-04-04 22:48:41 +02: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`
44 lines
1.3 KiB
Rust
44 lines
1.3 KiB
Rust
use crate::PluginCustomValue;
|
|
use nu_protocol::{CustomValue, ShellError, Span, Value};
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// A custom value that can be used for testing.
|
|
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
|
|
pub struct TestCustomValue(pub i32);
|
|
|
|
#[typetag::serde(name = "nu_plugin_protocol::test_util::TestCustomValue")]
|
|
impl CustomValue for TestCustomValue {
|
|
fn clone_value(&self, span: Span) -> Value {
|
|
Value::custom(Box::new(self.clone()), span)
|
|
}
|
|
|
|
fn type_name(&self) -> String {
|
|
"TestCustomValue".into()
|
|
}
|
|
|
|
fn to_base_value(&self, span: Span) -> Result<Value, ShellError> {
|
|
Ok(Value::int(self.0 as i64, span))
|
|
}
|
|
|
|
fn as_any(&self) -> &dyn std::any::Any {
|
|
self
|
|
}
|
|
|
|
fn as_mut_any(&mut self) -> &mut dyn std::any::Any {
|
|
self
|
|
}
|
|
}
|
|
|
|
/// A [`TestCustomValue`] serialized as a [`PluginCustomValue`].
|
|
pub fn test_plugin_custom_value() -> PluginCustomValue {
|
|
let data = bincode::serialize(&expected_test_custom_value() as &dyn CustomValue)
|
|
.expect("bincode serialization of the expected_test_custom_value() failed");
|
|
|
|
PluginCustomValue::new("TestCustomValue".into(), data, false)
|
|
}
|
|
|
|
/// The expected [`TestCustomValue`] that [`test_plugin_custom_value()`] should deserialize into.
|
|
pub fn expected_test_custom_value() -> TestCustomValue {
|
|
TestCustomValue(-1)
|
|
}
|