Enum nu_protocol::ReturnSuccess

pub enum ReturnSuccess {
    Value(Value),
    DebugValue(Value),
    Action(CommandAction),
}

The fundamental success type in the pipeline. Commands return these values as their main responsibility

Variants

Value(Value)

A value to be used or shown to the user

DebugValue(Value)

A debug-enabled value to be used or shown to the user

Action(CommandAction)

An action to be performed as values pass out of the command. These are performed rather than passed to the next command in the pipeline

Implementations

impl ReturnSuccess

pub fn raw_value(&self) -> Option<Value>

Get to the contained Value, if possible

pub fn change_cwd(path: String) -> ReturnValue

Helper function for an action to change the the path

pub fn value(input: impl Into<Value>) -> ReturnValue

Helper function to create simple values for returning

pub fn debug_value(input: impl Into<Value>) -> ReturnValue

Helper function to create simple debug-enabled values for returning

pub fn action(input: CommandAction) -> ReturnValue

Helper function for creating actions

Trait Implementations

impl Clone for ReturnSuccess

fn clone(&self) -> ReturnSuccess

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReturnSuccess

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReturnSuccess

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PrettyDebug for ReturnSuccess

fn pretty(&self) -> DebugDocBuilder

Get a return success ready to be pretty-printed

pub fn to_doc(&self) -> DebugDoc

pub fn pretty_doc(
    &self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>

pub fn pretty_builder(
    &self
) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>

pub fn display(&self) -> String

A convenience method that prints out the document without colors in 70 columns. Generally, you should use plain_string or colored_string if possible, but display() can be useful for trace lines and things like that, where you don’t have control over the terminal.

pub fn plain_string(&self, width: usize) -> String

pub fn colored_string(&self, width: usize) -> String

impl Serialize for ReturnSuccess

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

Serialize this value into the given Serde serializer.