Struct PluginRegistryItem

pub struct PluginRegistryItem {
    pub name: String,
    pub filename: PathBuf,
    pub shell: Option<PathBuf>,
    pub data: PluginRegistryItemData,
}

A single plugin definition from a PluginRegistryFile.

Contains the information necessary for the PluginIdentity, as well as possibly valid data about the plugin including the registered command signatures.

Fields

name: String

The name of the plugin, as would show in plugin list. This does not include the file extension or the nu_plugin_ prefix.

filename: PathBuf

The path to the file.

shell: Option<PathBuf>

The shell program used to run the plugin, if applicable.

data: PluginRegistryItemData

Additional data that might be invalid so that we don’t fail to load the whole plugin file if there’s a deserialization error.

Implementations

impl PluginRegistryItem

pub fn new( identity: &PluginIdentity, metadata: PluginMetadata, commands: Vec<PluginSignature>, ) -> PluginRegistryItem

Create a PluginRegistryItem from an identity, metadata, and signatures.

Trait Implementations

impl Clone for PluginRegistryItem

fn clone(&self) -> PluginRegistryItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginRegistryItem

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginRegistryItem

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PluginRegistryItem

fn eq(&self, other: &PluginRegistryItem) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PluginRegistryItem

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PluginRegistryItem