Struct nu_plugin_inc::Inc

pub struct Inc {
    pub field: Option<Tagged<ColumnPath>>,
    pub error: Option<String>,
    pub action: Option<Action>,
}

Fields

field: Option<Tagged<ColumnPath>>

error: Option<String>

action: Option<Action>

Implementations

impl Inc

pub fn new() -> Self

pub fn for_semver(&mut self, part: SemVerAction)

pub fn usage() -> &'static str

pub fn inc(&self, value: Value) -> Result<Value, ShellError>

Trait Implementations

impl Default for Inc

fn default() -> Inc

Returns the “default value” for a type.

impl Plugin for Inc

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.

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<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.

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.

fn quit(&mut self)