Struct PluginSource

pub struct PluginSource { /* private fields */ }

The source of a custom value or plugin command. Includes a weak reference to the persistent plugin so it can be retrieved.

Implementations

impl PluginSource

pub fn new(plugin: Arc<dyn GetPlugin>) -> PluginSource

Create from an implementation of GetPlugin

pub fn new_fake(name: &str) -> PluginSource

Create a new fake source with a fake identity, for testing

Warning: .persistent() will always return an error.

pub fn persistent( &self, span: Option<Span>, ) -> Result<Arc<dyn GetPlugin>, ShellError>

Try to upgrade the persistent reference, and return an error referencing span as the object that referenced it otherwise

Methods from Deref<Target = PluginIdentity>

pub fn filename(&self) -> &Path

The filename of the plugin executable.

pub fn shell(&self) -> Option<&Path>

The shell command used by the plugin.

pub fn name(&self) -> &str

The name of the plugin, determined by the part of the filename after nu_plugin_ excluding the extension.

• C:\nu_plugin_inc.exe becomes inc
• /home/nu/.cargo/bin/nu_plugin_inc becomes inc

pub fn add_command(&self) -> String

A command that could be used to add the plugin, for suggesting in errors.

pub fn use_command(&self) -> String

A command that could be used to reload the plugin, for suggesting in errors.

Trait Implementations

impl Clone for PluginSource

fn clone(&self) -> PluginSource

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PluginSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for PluginSource

type Target = PluginIdentity

The resulting type after dereferencing.

fn deref(&self) -> &PluginIdentity

Dereferences the value.