Struct PluginCustomValue 

pub struct PluginCustomValue(/* private fields */);

An opaque container for a custom value that is handled fully by a plugin.

This is the only type of custom value that is allowed to cross the plugin serialization boundary.

The plugin is responsible for ensuring that local plugin custom values are converted to and from PluginCustomValue on the boundary.

The engine is responsible for adding tracking the source of the custom value, ensuring that only PluginCustomValue is contained within any values sent, and that the source of any values sent matches the plugin it is being sent to.

Most of the CustomValue methods on this type will result in a panic. The source must be added (see nu_plugin_engine::PluginCustomValueWithSource) in order to implement the functionality via plugin calls.

Implementations

impl PluginCustomValue

pub fn new( name: String, data: Vec<u8>, notify_on_drop: bool, ) -> PluginCustomValue

Create a new PluginCustomValue.

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

Create a Value containing this custom value.

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 serialize_from_custom_value( custom_value: &dyn CustomValue, span: Span, ) -> Result<PluginCustomValue, ShellError>

Serialize a custom value into a PluginCustomValue. This should only be done on the plugin side.

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.

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

Convert all plugin-native custom values to PluginCustomValue within the given value, recursively. This should only be done on the plugin side.

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

Convert all PluginCustomValues to plugin-native custom values within the given value, recursively. This should only be done on the plugin side.

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

Render any custom values in the Value using to_base_value()

Trait Implementations

impl Clone for PluginCustomValue

fn clone(&self) -> PluginCustomValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomValue for PluginCustomValue

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 PluginCustomValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PluginCustomValue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PluginCustomValue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.