shepherd-rs 0.2.0

Shepherd is a resilient, non-blocking orchestrator that persistently transforms and delivers data—built for remote, compute-heavy workloads.
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
61
62
63
64
65
66
67

//! # Transform Request Trait
//!
//! This trait defines the behavior of transformation requests in the
//! shepherd framework.
//!
//! ## Overview
//! - **TransformRequest**: Represents a request to transform input data into
//!   output data.
//! - **Identifier**: Provides unique identifiers for tracking requests.
//!
//! ## Example
//! ```rust
//! struct MyTransformRequest;
//!
//! impl TransformRequest for MyTransformRequest {
//!     // Implementation details...
//! }
//! ```

use std::fmt::Debug;

/// A trait representing a transformation request in shepherd-rs processing
/// system. Each transformation request is a request to transform some input
/// data into an output format. As such, the `Input` and `Output` types are
/// generic, associated types allowing for flexibility in the types of data
/// being transformed.
pub trait TransformRequest: Send + Sync + Debug + Clone {
    /// A unique identifier for the transformation request.
    /// This needs to be unique across all transformation requests,
    /// across different shepherd-rs instances (process failures, etc.).
    type Identifier: Send + Sync + Eq + Debug;

    /// The type of the input for the transformation.
    type Input: Send + Clone;

    /// The type of the output expected after the transformation.
    type Output: Send + Clone;

    /// Returns the unique identifier for the transformation request.
    fn request_id(&self) -> Self::Identifier;

    /// Returns the input for the transformation request.
    fn input(&self) -> &Self::Input;

    /// Given the TransformRequest is the latest in the stream,
    /// what dynamic configs need to be updated, Key is always a
    /// string, value is always a `Vec<u8>` representing the serialized
    /// value
    fn get_dyn_configs(&self) -> Vec<(String, Vec<u8>)>;
}

#[cfg(test)]
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct NilTR;

#[cfg(test)]
impl TransformRequest for NilTR {
    type Identifier = ();
    type Input = ();
    type Output = ();

    fn request_id(&self) -> Self::Identifier { () }

    fn input(&self) -> &Self::Input { &() }

    fn get_dyn_configs(&self) -> Vec<(String, Vec<u8>)> { vec![] }
}