Struct PluginCustomValueWithSource

pub struct PluginCustomValueWithSource { /* private fields */ }

Wraps a PluginCustomValue together with its PluginSource, so that the CustomValue methods can be implemented by calling the plugin, and to ensure that any custom values sent to a plugin came from it originally.

Implementations

impl PluginCustomValueWithSource

pub fn new( inner: PluginCustomValue, source: Arc<PluginSource>, ) -> PluginCustomValueWithSource

Wrap a PluginCustomValue together with its source.

pub fn into_value(self, span: Span) -> Value

Create a Value containing this custom value.

pub fn source(&self) -> &Arc<PluginSource>

Which plugin the custom value came from. This provides a direct reference to be able to get a plugin interface in order to make a call, when needed.

pub fn without_source(self) -> PluginCustomValue

Unwrap the PluginCustomValueWithSource, discarding the source.

pub fn add_source(value: &mut Box<dyn CustomValue>, source: &Arc<PluginSource>)

Add a PluginSource to the given CustomValue if it is a PluginCustomValue.

pub fn add_source_in( value: &mut Value, source: &Arc<PluginSource>, ) -> Result<(), ShellError>

Add a PluginSource to all PluginCustomValues within the value, recursively.

pub fn remove_source(value: &mut Box<dyn CustomValue>)

Remove a PluginSource from the given CustomValue if it is a PluginCustomValueWithSource. This will turn it back into a PluginCustomValue.

pub fn remove_source_in(value: &mut Value) -> Result<(), ShellError>

Remove the PluginSource from all PluginCustomValues within the value, recursively.

pub fn verify_source( &self, span: Span, source: &PluginSource, ) -> Result<(), ShellError>

Check that self came from the given source, and return an error if not.

pub fn verify_source_of_custom_value( value: Spanned<&dyn CustomValue>, source: &PluginSource, ) -> Result<(), ShellError>

Check that a CustomValue is a PluginCustomValueWithSource that came from the given source, and return an error if not.

Methods from Deref<Target = PluginCustomValue>

pub fn name(&self) -> &str

The name of the type of the custom value as defined by the plugin (type_name())

pub fn data(&self) -> &[u8]

The bincoded representation of the custom value on the plugin side

pub fn notify_on_drop(&self) -> bool

True if the custom value should notify the source if all copies of it are dropped.

pub fn ref_count(&self) -> usize

Count the number of shared copies of this PluginCustomValue.

pub fn deserialize_to_custom_value( &self, span: Span, ) -> Result<Box<dyn CustomValue>, ShellError>

Deserialize a PluginCustomValue into a Box<dyn CustomValue>. This should only be done on the plugin side.

Trait Implementations

impl Clone for PluginCustomValueWithSource

fn clone(&self) -> PluginCustomValueWithSource

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CustomValue for PluginCustomValueWithSource

fn clone_value(&self, span: Span) -> Value

Custom Clone implementation

fn type_name(&self) -> String

The friendly type name to show for the custom value, e.g. in describe and in error messages. This does not have to be the same as the name of the struct or enum, but conventionally often is.

fn to_base_value(&self, span: Span) -> Result<Value, ShellError>

Converts the custom value to a base nushell value.

fn follow_path_int( &self, self_span: Span, index: usize, path_span: Span, ) -> Result<Value, ShellError>

Follow cell path by numeric index (e.g. rows)

fn follow_path_string( &self, self_span: Span, column_name: String, path_span: Span, ) -> Result<Value, ShellError>

Follow cell path by string key (e.g. columns)

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

ordering with other value (see std::cmp::PartialOrd)

fn operation( &self, lhs_span: Span, operator: Operator, op_span: Span, right: &Value, ) -> Result<Value, ShellError>

Definition of an operation between the object that implements the trait and another Value.

fn as_any(&self) -> &dyn Any

Any representation used to downcast object to its original type

fn as_mut_any(&mut self) -> &mut dyn Any

Any representation used to downcast object to its original type (mutable reference)

fn notify_plugin_on_drop(&self) -> bool

For custom values in plugins: return true here if you would like to be notified when all copies of this custom value are dropped in the engine.

impl Debug for PluginCustomValueWithSource

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

Formats the value using the given formatter.

impl Deref for PluginCustomValueWithSource

type Target = PluginCustomValue

The resulting type after dereferencing.

fn deref(&self) -> &PluginCustomValue

Dereferences the value.

impl Drop for PluginCustomValueWithSource

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for PluginCustomValueWithSource

This Serialize implementation always produces an error. Strip the source before sending.

fn serialize<S>(&self, _serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.