efflux 2.0.1

Easy MapReduce and Hadoop Streaming interfaces in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

//! Efflux is a set of Rust interfaces for MapReduce and Hadoop Streaming.
//!
//! This crate provides easy interfaces for working with MapReduce, whether
//! or not you're running on the Hadoop platform. Usage is as simple as a
//! struct which implements either the `Mapper` or `Reducer` trait, as all
//! other interaction is taken care of internally.
//!
//! Macros are provided for IO, to provide a compile-time guarantee of things
//! such as counter/status updates, or writing to the Hadoop task logs.
#![doc(html_root_url = "https://docs.rs/efflux/2.0.1")]
#[macro_use]
pub mod macros;
pub mod context;
pub mod io;
pub mod mapper;
pub mod reducer;

use self::mapper::Mapper;
use self::reducer::Reducer;

use self::mapper::MapperLifecycle;
use self::reducer::ReducerLifecycle;

use self::io::run_lifecycle;

/// Executes a `Mapper` against the current `stdin`.
#[inline]
pub fn run_mapper<M>(mapper: M)
where
    M: Mapper + 'static,
{
    run_lifecycle(MapperLifecycle::new(mapper));
}

/// Executes a `Reducer` against the current `stdin`.
#[inline]
pub fn run_reducer<R>(reducer: R)
where
    R: Reducer + 'static,
{
    run_lifecycle(ReducerLifecycle::new(reducer));
}

// prelude module
pub mod prelude {
    //! A "prelude" for crates using the `efflux` crate.
    //!
    //! This prelude contains the required imports for almost all use cases, to
    //! avoid having to include modules and structures directly:
    //!
    //! ```rust
    //! use efflux::prelude::*;
    //! ```
    //!
    //! The prelude may grow over time, but it is unlikely to shrink.
    pub use super::context::{Configuration, Context, Contextual};
    pub use super::log;
    pub use super::mapper::Mapper;
    pub use super::reducer::Reducer;
}