conch-runtime 0.1.2

A library for evaluating/executing programs written in the shell programming language.
Documentation
use {EXIT_SUCCESS, Spawn};
use env::{LastStatusEnvironment, ReportErrorEnvironment};
use error::IsFatalError;
use future::{Async, EnvFuture, Poll};
use spawn::{EnvFutureExt, ExitResult, FlattenedEnvFuture, SwallowNonFatal, swallow_non_fatal_errors};
use std::fmt;
use std::iter::Peekable;

#[derive(Debug)]
enum State<C, L> {
    Current(SwallowNonFatal<C>),
    Last(L),
    None,
}

type FlattenedState<E, F> = State<FlattenedEnvFuture<E, F>, E>;

/// A future that represents the sequential execution of commands.
///
/// Commands are sequentially executed regardless of the exit status of
/// previous commands. All non-fatal errors are reported and swallowed,
/// however, "fatal" errors are bubbled up and the sequence terminated.
#[must_use = "futures do nothing unless polled"]
pub struct Sequence<I, E: ?Sized>
    where I: Iterator,
          I::Item: Spawn<E>,
{
    state: FlattenedState<<I::Item as Spawn<E>>::EnvFuture, <I::Item as Spawn<E>>::Future>,
    iter: Peekable<I>,
}

impl<S, I, E: ?Sized> fmt::Debug for Sequence<I, E>
    where I: Iterator<Item = S> + fmt::Debug,
          S: Spawn<E> + fmt::Debug,
          S::EnvFuture: fmt::Debug,
          S::Future: fmt::Debug,
{
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.debug_struct("Sequence")
            .field("state", &self.state)
            .field("iter", &self.iter)
            .finish()
    }
}

impl<S, I, E: ?Sized> EnvFuture<E> for Sequence<I, E>
    where E: LastStatusEnvironment + ReportErrorEnvironment,
          I: Iterator<Item = S>,
          S: Spawn<E>,
          S::Error: IsFatalError,
{
    type Item = ExitResult<S::Future>;
    type Error = S::Error;

    fn poll(&mut self, env: &mut E) -> Poll<Self::Item, Self::Error> {
        loop {
            match self.state {
                State::None => {},
                State::Current(ref mut e) => {
                    let exit = try_ready!(e.poll(env));
                    env.set_last_status(exit);
                },
                State::Last(ref mut e) => {
                    let future = try_ready!(e.poll(env));
                    return Ok(Async::Ready(ExitResult::Pending(future)));
                },
            }

            match self.iter.next().map(|s| s.spawn(env)) {
                Some(e) => {
                    let next_state = match self.iter.peek() {
                        Some(_) => State::Current(swallow_non_fatal_errors(e.flatten_future())),
                        None => State::Last(e),
                    };
                    self.state = next_state;
                },
                None => return Ok(Async::Ready(ExitResult::Ready(EXIT_SUCCESS))),
            }
        }
    }

    fn cancel(&mut self, env: &mut E) {
        match self.state {
            State::Current(ref mut e) => e.cancel(env),
            State::Last(ref mut e) => e.cancel(env),
            State::None => {},
        }
    }
}

/// Spawns any iterable collection of sequential items.
///
/// Commands are sequentially executed regardless of the exit status of
/// previous commands. All non-fatal errors are reported and swallowed,
/// however, "fatal" errors are bubbled up and the sequence terminated.
pub fn sequence<I, E: ?Sized>(iter: I) -> Sequence<I::IntoIter, E>
    where E: LastStatusEnvironment + ReportErrorEnvironment,
          I: IntoIterator,
          I::Item: Spawn<E>,
{
    Sequence {
        state: State::None,
        iter: iter.into_iter().peekable(),
    }
}