mirror of
https://github.com/nushell/nushell.git
synced 2025-03-24 21:47:56 +01: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`
64 lines
2.3 KiB
Rust
64 lines
2.3 KiB
Rust
use super::GetPlugin;
|
|
use nu_protocol::{PluginIdentity, ShellError, Span};
|
|
use std::sync::{Arc, Weak};
|
|
|
|
/// The source of a custom value or plugin command. Includes a weak reference to the persistent
|
|
/// plugin so it can be retrieved.
|
|
#[derive(Debug, Clone)]
|
|
pub struct PluginSource {
|
|
/// The identity of the plugin
|
|
pub(crate) identity: Arc<PluginIdentity>,
|
|
/// A weak reference to the persistent plugin that might hold an interface to the plugin.
|
|
///
|
|
/// This is weak to avoid cyclic references, but it does mean we might fail to upgrade if
|
|
/// the engine state lost the [`PersistentPlugin`] at some point.
|
|
pub(crate) persistent: Weak<dyn GetPlugin>,
|
|
}
|
|
|
|
impl PluginSource {
|
|
/// Create from an implementation of `GetPlugin`
|
|
pub fn new(plugin: Arc<dyn GetPlugin>) -> PluginSource {
|
|
PluginSource {
|
|
identity: plugin.identity().clone().into(),
|
|
persistent: Arc::downgrade(&plugin),
|
|
}
|
|
}
|
|
|
|
/// Create a new fake source with a fake identity, for testing
|
|
///
|
|
/// Warning: [`.persistent()`] will always return an error.
|
|
pub fn new_fake(name: &str) -> PluginSource {
|
|
PluginSource {
|
|
identity: PluginIdentity::new_fake(name).into(),
|
|
persistent: Weak::<crate::PersistentPlugin>::new(),
|
|
}
|
|
}
|
|
|
|
/// Try to upgrade the persistent reference, and return an error referencing `span` as the
|
|
/// object that referenced it otherwise
|
|
pub fn persistent(&self, span: Option<Span>) -> Result<Arc<dyn GetPlugin>, ShellError> {
|
|
self.persistent
|
|
.upgrade()
|
|
.ok_or_else(|| ShellError::GenericError {
|
|
error: format!("The `{}` plugin is no longer present", self.identity.name()),
|
|
msg: "removed since this object was created".into(),
|
|
span,
|
|
help: Some("try recreating the object that came from the plugin".into()),
|
|
inner: vec![],
|
|
})
|
|
}
|
|
|
|
/// Sources are compatible if their identities are equal
|
|
pub(crate) fn is_compatible(&self, other: &PluginSource) -> bool {
|
|
self.identity == other.identity
|
|
}
|
|
}
|
|
|
|
impl std::ops::Deref for PluginSource {
|
|
type Target = PluginIdentity;
|
|
|
|
fn deref(&self) -> &PluginIdentity {
|
|
&self.identity
|
|
}
|
|
}
|