Struct bawawa::Capture

pub struct Capture<'a, C, D, R, Item> where
    R: AsyncRead,  { /* fields omitted */ }

capture the standard output or standard error output from a running process

created from StandardOutput::capture_stdout and StandardError::capture_stderr. This object implements the Stream trait from the futures crate. This allows to iterate through the frames that are being captured.

composition of captures

It is possible to compose the capturing standard output and standard error:

Process::spawn(cmd)?
    .capture_stderr(LinesCodec::new())
    .capture_stdout(LinesCodec::new())

However it is not possible to capture twice from the standard output or twice from the standard error. This is because we are holding only one handler to the Pipe which capture the standard output or the standard error output. The API prevents this to happen by removing the capability to access respectively the standard output or the standard error output once captured. Example:

Process::spawn(cmd)?
    .capture_stdout(LinesCodec::new())
    .capture_stderr(LinesCodec::new())
    .capture_stdout(LinesCodec::new()) // this line does not compile

Process::spawn(cmd)?
    .capture_stderr(LinesCodec::new())
    .capture_stderr(LinesCodec::new()) // this line does not compile

Trait Implementations

impl<'a, C, D, R, Item> Control for Capture<'a, C, D, R, Item> where
    C: Control,
    R: AsyncRead, 

fn command(&self) -> &Command

access the underlying command settings

fn id(&self) -> u32

retrieve the Process ID of the given running program.

fn kill(&mut self) -> Result<(), Error>

force the process to finish

impl<'a, C, D, R, Item> StandardInput<'a> for Capture<'a, C, D, R, Item> where
    R: AsyncRead,
    C: StandardInput<'a>,
    D: 'a,
    Item: 'a, 

fn standard_input(&mut self) -> &mut ChildStdin

get access to the standard input so we can send in data

fn framed_stdin<E, Item>(
    &mut self,
    encoder: E
) -> FramedWrite<&mut ChildStdin, E> where
    E: Encoder<Item = Item>, 

fn send_stdin<E, Item>(self, encoder: E) -> SendStdin<'a, Self, E, Item> where
    E: Encoder<Item = Item>, 

impl<'a, C, D, Item> StandardOutput<'a> for Capture<'a, C, D, ChildStderr, Item> where
    C: StandardOutput<'a>,
    D: 'a,
    Item: 'a, 

fn standard_output(&mut self) -> &mut ChildStdout

get access to the standard output

fn framed_stdout<D, Item>(
    &mut self,
    decoder: D
) -> FramedRead<&mut ChildStdout, D> where
    D: Decoder<Item = Item>, 

fn capture_stdout<D, Item>(
    self,
    decoder: D
) -> Capture<'a, Self, D, ChildStdout, Item> where
    D: Decoder<Item = Item>, 

impl<'a, C, D, Item> StandardError<'a> for Capture<'a, C, D, ChildStdout, Item> where
    C: StandardError<'a>,
    D: 'a,
    Item: 'a, 

fn standard_error(&mut self) -> &mut ChildStderr

get access to the standard output

fn framed_stderr<D, Item>(
    &mut self,
    decoder: D
) -> FramedRead<&mut ChildStderr, D> where
    D: Decoder<Item = Item>, 

fn capture_stderr<D, Item>(
    self,
    decoder: D
) -> Capture<'a, Self, D, ChildStderr, Item> where
    D: Decoder<Item = Item>, 

impl<'a, C, D, R, Item> Drop for Capture<'a, C, D, R, Item> where
    R: AsyncRead, 

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, C, D, E, R, Item> Stream for Capture<'a, C, D, R, Item> where
    R: AsyncRead,
    D: Decoder<Item = Item, Error = E>,
    E: Error + Send + From<Error> + 'static, 

type Item = Item

The type of item this stream will yield on success.

type Error = Error

The type of error this stream may generate.

fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error>

Attempt to pull out the next value of this stream, returning None if the stream is finished.

fn wait(self) -> Wait<Self>

Creates an iterator which blocks the current thread until each item of this stream is resolved.

fn into_future(self) -> StreamFuture<Self>

Converts this stream into a Future.

fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> U, 

Converts a stream of type T to a stream of type U.

fn map_err<U, F>(self, f: F) -> MapErr<Self, F> where
    F: FnMut(Self::Error) -> U, 

Converts a stream of error type T to a stream of error type U.

fn filter<F>(self, f: F) -> Filter<Self, F> where
    F: FnMut(&Self::Item) -> bool, 

Filters the values produced by this stream according to the provided predicate.

fn filter_map<F, B>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 

Filters the values produced by this stream while simultaneously mapping them to a different type.

fn then<F, U>(self, f: F) -> Then<Self, F, U> where
    F: FnMut(Result<Self::Item, Self::Error>) -> U,
    U: IntoFuture, 

Chain on a computation for when a value is ready, passing the resulting item to the provided closure f.

fn and_then<F, U>(self, f: F) -> AndThen<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Error = Self::Error>, 

Chain on a computation for when a value is ready, passing the successful results to the provided closure f.

fn or_else<F, U>(self, f: F) -> OrElse<Self, F, U> where
    F: FnMut(Self::Error) -> U,
    U: IntoFuture<Item = Self::Item>, 

Chain on a computation for when an error happens, passing the erroneous result to the provided closure f.

fn collect(self) -> Collect<Self>

Collect all of the values of this stream into a vector, returning a future representing the result of that computation.

fn concat2(self) -> Concat2<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator,
    Self::Item: Default, 

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

fn concat(self) -> Concat<Self> where
    Self::Item: Extend<<Self::Item as IntoIterator>::Item>,
    Self::Item: IntoIterator, 

Deprecated since 0.1.14:

please use Stream::concat2 instead

Concatenate all results of a stream into a single extendable destination, returning a future representing the end result.

fn fold<F, T, Fut>(self, init: T, f: F) -> Fold<Self, F, Fut, T> where
    F: FnMut(T, Self::Item) -> Fut,
    Fut: IntoFuture<Item = T>,
    Self::Error: From<<Fut as IntoFuture>::Error>, 

Execute an accumulating computation over a stream, collecting all the values into one final result.

fn flatten(self) -> Flatten<Self> where
    Self::Item: Stream,
    <Self::Item as Stream>::Error: From<Self::Error>, 

Flattens a stream of streams into just one continuous stream.

fn skip_while<P, R>(self, pred: P) -> SkipWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 

Skip elements on this stream while the predicate provided resolves to true.

fn take_while<P, R>(self, pred: P) -> TakeWhile<Self, P, R> where
    P: FnMut(&Self::Item) -> R,
    R: IntoFuture<Item = bool, Error = Self::Error>, 

Take elements from this stream while the predicate provided resolves to true.

fn for_each<F, U>(self, f: F) -> ForEach<Self, F, U> where
    F: FnMut(Self::Item) -> U,
    U: IntoFuture<Item = (), Error = Self::Error>, 

Runs this stream to completion, executing the provided closure for each element on the stream.

fn from_err<E>(self) -> FromErr<Self, E> where
    E: From<Self::Error>, 

Map this stream's error to any error implementing From for this stream's Error, returning a new stream.

fn take(self, amt: u64) -> Take<Self>

Creates a new stream of at most amt items of the underlying stream.

fn skip(self, amt: u64) -> Skip<Self>

Creates a new stream which skips amt items of the underlying stream.

fn fuse(self) -> Fuse<Self>

Fuse a stream such that poll will never again be called once it has finished.

fn by_ref(&mut self) -> &mut Self

Borrows a stream, rather than consuming it.

fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: UnwindSafe, 

Catches unwinding panics while polling the stream.

fn buffered(self, amt: usize) -> Buffered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures.

fn buffer_unordered(self, amt: usize) -> BufferUnordered<Self> where
    Self::Item: IntoFuture,
    <Self::Item as IntoFuture>::Error == Self::Error, 

An adaptor for creating a buffered list of pending futures (unordered).

fn merge<S>(self, other: S) -> Merge<Self, S> where
    S: Stream<Error = Self::Error>, 

Deprecated:

functionality provided by select now

An adapter for merging the output of two streams.

fn zip<S>(self, other: S) -> Zip<Self, S> where
    S: Stream<Error = Self::Error>, 

An adapter for zipping two streams together.

fn chain<S>(self, other: S) -> Chain<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Adapter for chaining two stream.

fn peekable(self) -> Peekable<Self>

Creates a new stream which exposes a peek method.

fn chunks(self, capacity: usize) -> Chunks<Self>

An adaptor for chunking up items of the stream inside a vector.

fn select<S>(self, other: S) -> Select<Self, S> where
    S: Stream<Item = Self::Item, Error = Self::Error>, 

Creates a stream that selects the next element from either this stream or the provided one, whichever is ready first.

fn forward<S>(self, sink: S) -> Forward<Self, S> where
    S: Sink<SinkItem = Self::Item>,
    Self::Error: From<<S as Sink>::SinkError>, 

A future that completes after the given stream has been fully processed into the sink, including flushing.

fn split(self) -> (SplitSink<Self>, SplitStream<Self>) where
    Self: Sink, 

Splits this Stream + Sink object into separate Stream and Sink objects.

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 

Do something with each item of this stream, afterwards passing it on.

fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where
    F: FnMut(&Self::Error), 

Do something with the error of this stream, afterwards passing it on.

impl<'a, C, D, R, Item> Sink for Capture<'a, C, D, R, Item> where
    C: Sink,
    R: AsyncRead, 

type SinkItem = <C as Sink>::SinkItem

The type of value that the sink accepts.

type SinkError = <C as Sink>::SinkError

The type of value produced by the sink when an error occurs.

fn start_send(
    &mut self,
    item: Self::SinkItem
) -> StartSend<Self::SinkItem, Self::SinkError>

Begin the process of sending a value to the sink.

fn poll_complete(&mut self) -> Poll<(), Self::SinkError>

Flush all output from this sink, if necessary.

fn close(&mut self) -> Result<Async<()>, Self::SinkError>

A method to indicate that no more values will ever be pushed into this sink.

fn wait(self) -> Wait<Self>

Creates a new object which will produce a synchronous sink.

fn with<U, F, Fut>(self, f: F) -> With<Self, U, F, Fut> where
    F: FnMut(U) -> Fut,
    Fut: IntoFuture<Item = Self::SinkItem>,
    <Fut as IntoFuture>::Error: From<Self::SinkError>, 

Composes a function in front of the sink.

fn with_flat_map<U, F, St>(self, f: F) -> WithFlatMap<Self, U, F, St> where
    F: FnMut(U) -> St,
    St: Stream<Item = Self::SinkItem, Error = Self::SinkError>, 

Composes a function in front of the sink.

fn sink_map_err<F, E>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::SinkError) -> E, 

Transforms the error returned by the sink.

fn sink_from_err<E>(self) -> SinkFromErr<Self, E> where
    E: From<Self::SinkError>, 

Map this sink's error to any error implementing From for this sink's Error, returning a new sink.

fn buffer(self, amt: usize) -> Buffer<Self>

Adds a fixed-size buffer to the current sink.

fn fanout<S>(self, other: S) -> Fanout<Self, S> where
    S: Sink<SinkItem = Self::SinkItem, SinkError = Self::SinkError>,
    Self::SinkItem: Clone, 

Fanout items to multiple sinks.

fn flush(self) -> Flush<Self>

A future that completes when the sink has finished processing all pending requests.

fn send(self, item: Self::SinkItem) -> Send<Self>

A future that completes after the given item has been fully processed into the sink, including flushing.

fn send_all<S>(self, stream: S) -> SendAll<Self, S> where
    S: Stream<Item = Self::SinkItem>,
    Self::SinkError: From<<S as Stream>::Error>, 

A future that completes after the given stream has been fully processed into the sink, including flushing.