Enum nu_protocol::ReturnSuccess [−][src]
pub enum ReturnSuccess { Value(Value), DebugValue(Value), Action(CommandAction), }
Expand description
The fundamental success type in the pipeline. Commands return these values as their main responsibility
Variants
Value(Value)
Expand description
A value to be used or shown to the user
DebugValue(Value)
Expand description
A debug-enabled value to be used or shown to the user
Action(CommandAction)
Expand description
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
[src]
impl ReturnSuccess
[src]pub fn change_cwd(path: String) -> ReturnValue
[src]
pub fn change_cwd(path: String) -> ReturnValue
[src]Helper function for an action to change the the path
pub fn value(input: impl Into<Value>) -> ReturnValue
[src]
pub fn value(input: impl Into<Value>) -> ReturnValue
[src]Helper function to create simple values for returning
pub fn debug_value(input: impl Into<Value>) -> ReturnValue
[src]
pub fn debug_value(input: impl Into<Value>) -> ReturnValue
[src]Helper function to create simple debug-enabled values for returning
pub fn action(input: CommandAction) -> ReturnValue
[src]
pub fn action(input: CommandAction) -> ReturnValue
[src]Helper function for creating actions
Trait Implementations
impl Clone for ReturnSuccess
[src]
impl Clone for ReturnSuccess
[src]fn clone(&self) -> ReturnSuccess
[src]
fn clone(&self) -> ReturnSuccess
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for ReturnSuccess
[src]
impl Debug for ReturnSuccess
[src]impl<'de> Deserialize<'de> for ReturnSuccess
[src]
impl<'de> Deserialize<'de> for ReturnSuccess
[src]fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl PrettyDebug for ReturnSuccess
[src]
impl PrettyDebug for ReturnSuccess
[src]fn pretty(&self) -> DebugDocBuilder
[src]
fn pretty(&self) -> DebugDocBuilder
[src]Get a return success ready to be pretty-printed
fn to_doc(&self) -> DebugDoc
[src]
fn pretty_doc(
&self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>
[src]
&self
) -> Doc<'static, BoxDoc<'static, ShellAnnotation>, ShellAnnotation>
fn pretty_builder(&self) -> DocBuilder<'static, BoxAllocator, ShellAnnotation>
[src]
fn display(&self) -> String
[src]
fn display(&self) -> String
[src]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. Read more
fn plain_string(&self, width: usize) -> String
[src]
fn colored_string(&self, width: usize) -> String
[src]
impl Serialize for ReturnSuccess
[src]
impl Serialize for ReturnSuccess
[src]Auto Trait Implementations
impl RefUnwindSafe for ReturnSuccess
impl Send for ReturnSuccess
impl Sync for ReturnSuccess
impl Unpin for ReturnSuccess
impl UnwindSafe for ReturnSuccess
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> PrettyDebugWithSource for T where
T: PrettyDebug,
[src]
impl<T> PrettyDebugWithSource for T where
T: PrettyDebug,
[src]pub fn pretty_debug(&self, _source: &str) -> DebugDocBuilder
[src]
fn refined_pretty_debug(
&self,
_refine: PrettyDebugRefineKind,
source: &str
) -> DebugDocBuilder
[src]
&self,
_refine: PrettyDebugRefineKind,
source: &str
) -> DebugDocBuilder
fn debug(&self, source: impl Into<Text>) -> String where
Self: Clone,
[src]
Self: Clone,
fn debuggable(self, source: impl Into<Text>) -> DebuggableWithSource<Self>
[src]
impl<T> SpannedItem for T
[src]
impl<T> SpannedItem for T
[src]impl<T> TaggedItem for T
[src]
impl<T> TaggedItem for T
[src]impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,