Trait mapped_command::OutputMapping

pub trait OutputMapping: 'static {
    type Output: 'static;
    type Error: 'static;
    fn capture_stdout(&self) -> bool;
    fn capture_stderr(&self) -> bool;
    fn map_output(
        self: Box<Self>, 
        stdout: Option<Vec<u8>>, 
        stderr: Option<Vec<u8>>, 
        exit_status: ExitStatus
    ) -> Result<Self::Output, Self::Error>;
}

Trait used to configure what Command::run() returns.

Associated Types

type Output: 'static

The output produced by this command, if it is run and doesn't fail.

type Error: 'static

The error produced by this command, if it is run and does fail.

Loading content...

Required methods

fn capture_stdout(&self) -> bool

Return if stdout needs to be captured for this output mapping map_output function.

This should be a pure function only depending on &self.

fn capture_stderr(&self) -> bool

Return if stderr needs to be captured for this output mapping map_output function.

This should be a pure function only depending on &self.

fn map_output(
    self: Box<Self>,
    stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

The function called once the command's run completed.

This function is used to convert the captured stdout/stderr to an instance of the given Output type.

If exist code checking is enabled and fails this function will not be called.

If it is disabled this function will be called and the implementation can still decide to fail due to an unexpected/bad exit status.

Loading content...

Implementors

impl OutputMapping for ReturnNothing

type Output = ()

type Error = CommandExecutionError

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    self: Box<Self>,
    _stdout: Option<Vec<u8>>,
    _stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl OutputMapping for ReturnStderr

type Output = Vec<u8>

type Error = CommandExecutionError

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    self: Box<Self>,
    _stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl OutputMapping for ReturnStderrString

type Output = String

type Error = CommandExecutionWithStringOutputError

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    self: Box<Self>,
    _stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl OutputMapping for ReturnStdout

type Output = Vec<u8>

type Error = CommandExecutionError

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    self: Box<Self>,
    stdout: Option<Vec<u8>>,
    _stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl OutputMapping for ReturnStdoutAndErr

type Output = CapturedStdoutAndErr

type Error = CommandExecutionError

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    self: Box<Self>,
    stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl OutputMapping for ReturnStdoutAndErrStrings

type Output = CapturedStdoutAndErrStrings

type Error = CommandExecutionWithStringOutputError

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    self: Box<Self>,
    stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl OutputMapping for ReturnStdoutString

type Output = String

type Error = CommandExecutionWithStringOutputError

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    self: Box<Self>,
    stdout: Option<Vec<u8>>,
    _stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl<O, E, F> OutputMapping for MapStderr<O, E, F> where
    F: FnMut(Vec<u8>) -> Result<O, E>,
    E: From<CommandExecutionError>, 

type Output = O

type Error = E

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    mut self: Box<Self>,
    _stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl<O, E, F> OutputMapping for MapStderrString<O, E, F> where
    F: FnMut(String) -> Result<O, E>,
    E: From<CommandExecutionWithStringOutputError>, 

type Output = O

type Error = E

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    mut self: Box<Self>,
    _stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl<O, E, F> OutputMapping for MapStdout<O, E, F> where
    F: FnMut(Vec<u8>) -> Result<O, E>,
    E: From<CommandExecutionError>, 

type Output = O

type Error = E

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    mut self: Box<Self>,
    stdout: Option<Vec<u8>>,
    _stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl<O, E, F> OutputMapping for MapStdoutAndErr<O, E, F> where
    F: FnMut(CapturedStdoutAndErr) -> Result<O, E>,
    E: From<CommandExecutionError>, 

type Output = O

type Error = E

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    mut self: Box<Self>,
    stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl<O, E, F> OutputMapping for MapStdoutAndErrStrings<O, E, F> where
    F: FnMut(CapturedStdoutAndErrStrings) -> Result<O, E>,
    E: From<CommandExecutionWithStringOutputError>, 

type Output = O

type Error = E

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    mut self: Box<Self>,
    stdout: Option<Vec<u8>>,
    stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

impl<O, E, F> OutputMapping for MapStdoutString<O, E, F> where
    F: FnMut(String) -> Result<O, E>,
    E: From<CommandExecutionWithStringOutputError>, 

type Output = O

type Error = E

fn capture_stdout(&self) -> bool

fn capture_stderr(&self) -> bool

fn map_output(
    mut self: Box<Self>,
    stdout: Option<Vec<u8>>,
    _stderr: Option<Vec<u8>>,
    _exit_status: ExitStatus
) -> Result<Self::Output, Self::Error>

Loading content...