Struct PluginIdentity

pub struct PluginIdentity { /* private fields */ }

Implementations

impl PluginIdentity

pub fn new( filename: impl Into<PathBuf>, shell: Option<PathBuf>, ) -> Result<PluginIdentity, InvalidPluginFilename>

Create a new plugin identity from a path to plugin executable and shell option.

The filename must be an absolute path. Canonicalize before trying to construct the 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 PluginIdentity

fn clone(&self) -> PluginIdentity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PluginIdentity

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

Formats the value using the given formatter.

impl Hash for PluginIdentity

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PluginIdentity

fn cmp(&self, other: &PluginIdentity) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PluginIdentity

fn eq(&self, other: &PluginIdentity) -> 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 PartialOrd for PluginIdentity

fn partial_cmp(&self, other: &PluginIdentity) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PluginIdentity

impl StructuralPartialEq for PluginIdentity