Struct nu_plugin_to_bson::ToBson

pub struct ToBson {
    pub state: Vec<Value>,
}

Fields

state: Vec<Value>

Implementations

impl ToBson

pub fn new() -> ToBson

Trait Implementations

impl Default for ToBson

fn default() -> ToBson

Returns the “default value” for a type.

impl Plugin for ToBson

fn config(&mut self) -> Result<Signature, ShellError>

The config method is used to configure a plugin’s user interface / signature.

fn filter(&mut self, input: Value) -> Result<Vec<ReturnValue>, ShellError>

filter is called for every Value that is processed by the plugin. This method requires the plugin Signature to be configured as filterable.

fn end_filter(&mut self) -> Result<Vec<ReturnValue>, ShellError>

end_filter is the last method to be called by the plugin after all Values are processed by the plugin. This method requires the plugin Signature to be configured as filterable.

pub fn begin_filter(
    &mut self,
    _call_info: CallInfo
) -> Result<Vec<Result<ReturnSuccess, ShellError>, Global>, ShellError>

begin_filter is the first method to be called if the Signature of the plugin is configured to be filterable. Any setup required for the plugin such as parsing arguments from CallInfo or initializing data structures can be done here. The CallInfo parameter will contain data configured in the config method of the Plugin trait.

pub fn sink(&mut self, _call_info: CallInfo, _input: Vec<Value, Global>)

sink consumes the Values that are passed in, preventing further processing. This method requires the plugin Signature to be configured without filtering.

pub fn quit(&mut self)