Struct nu_plugin_start::Start

pub struct Start {
    pub tag: Tag,
    pub filenames: Vec<Tagged<String>>,
    pub application: Option<String>,
}

Fields

tag: Tag

filenames: Vec<Tagged<String>>

application: Option<String>

Implementations

impl Start

pub fn new() -> Start

pub fn parse(&mut self, call_info: CallInfo) -> Result<(), ShellError>

pub fn exec(&mut self) -> Result<(), ShellError>

Trait Implementations

impl Default for Start

fn default() -> Start

Returns the "default value" for a type.

impl Plugin for Start

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

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

fn begin_filter(
    &mut self,
    call_info: CallInfo
) -> Result<Vec<ReturnValue>, 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 filter(
    &mut self,
    _input: Value
) -> Result<Vec<Result<ReturnSuccess, ShellError>, Global>, ShellError>

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

pub fn end_filter(
    &mut self
) -> Result<Vec<Result<ReturnSuccess, ShellError>, Global>, 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 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)