Struct Chain

pub struct Chain { /* private fields */ }

The Chain struct represents a map-reduce chain, consisting of a map step and a reduce step.

The struct is generic over the type of the Step and provides methods for constructing and executing the chain using a given Executor.

Implementations

impl Chain

pub fn new(map: Step, reduce: Step) -> Chain

Constructs a new Chain with the given map and reduce steps.

The new function takes two instances of Step and returns a new Chain instance.

pub async fn run<E: Executor>( &self, documents: Vec<Parameters>, base_parameters: Parameters, executor: &E, ) -> Result<Output, MapReduceChainError>

Executes the map-reduce chain using the provided Executor.

The run function takes a vector of input documents, a base set of parameters, and a reference to an Executor. It processes the input documents using the map step and the reduce step, and returns the result as an Option<E::Output>.

The function is asynchronous and must be awaited.

Trait Implementations

impl<'de> Deserialize<'de> for Chain

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Chain

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StorableEntity for Chain

Implements the StorableEntity trait for the Chain struct.

This implementation provides a method for extracting metadata from a Chain instance, in order to identify it

fn get_metadata() -> Vec<(String, String)>

Returns metadata about the Chain instance.

The metadata is returned as a vector of tuples, where each tuple contains a key-value pair representing a metadata field and its value.

This method also extracts metadata from the Step instances associated with the Chain.

fn to_envelope(self) -> Envelope<Self>

where Self: Sized,

fn from_envelope(envelope: Envelope<Self>) -> Self

fn read_file_sync(path: &str) -> Result<Self, EnvelopeError>

fn write_file_sync(self, path: &str) -> Result<(), EnvelopeError>