dataflow-rs 4.0.1

A lightweight rules engine for building IFTTT-style automation and data processing pipelines in Rust. Define rules with JSONLogic conditions, execute actions, and chain workflows.
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

//! `FunctionSpec`: what a function says about itself, as data.

use crate::expr::FieldSpec;
use std::borrow::Cow;

/// Is running a function twice the same as running it once?
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
#[non_exhaustive]
pub enum RetrySafety {
    /// A repeat has the same effect as one run.
    Idempotent,
    /// A repeat has its effect again.
    NotIdempotent,
    /// Nothing is claimed.
    #[default]
    Unknown,
}

/// A config field that names another definition, such as a connector.
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub struct Reference {
    /// The config field holding the name.
    pub field: Cow<'static, str>,
    /// What it names, such as `connector`.
    pub kind: Cow<'static, str>,
}

impl Reference {
    /// A reference held in `field`, naming a `kind`.
    pub fn new(field: impl Into<Cow<'static, str>>, kind: impl Into<Cow<'static, str>>) -> Self {
        Self {
            field: field.into(),
            kind: kind.into(),
        }
    }
}

/// What a function says about itself, for tooling. Data only.
#[derive(Clone, Debug, Default)]
#[non_exhaustive]
pub struct FunctionSpec {
    /// What the function does.
    pub description: Cow<'static, str>,
    /// The group it is listed under.
    pub category: Cow<'static, str>,
    /// Whether a retry is safe.
    pub retry: RetrySafety,
    /// The config fields that name other definitions.
    pub references: Vec<Reference>,
    /// The config's fields, when a plugin declares them at runtime.
    pub runtime_fields: Option<Vec<FieldSpec>>,
}

impl FunctionSpec {
    /// Sets the description.
    #[must_use]
    pub fn with_description(mut self, description: impl Into<Cow<'static, str>>) -> Self {
        self.description = description.into();
        self
    }

    /// Sets the category.
    #[must_use]
    pub fn with_category(mut self, category: impl Into<Cow<'static, str>>) -> Self {
        self.category = category.into();
        self
    }

    /// Sets the retry safety.
    #[must_use]
    pub fn with_retry(mut self, retry: RetrySafety) -> Self {
        self.retry = retry;
        self
    }

    /// Sets the references.
    #[must_use]
    pub fn with_references(mut self, references: Vec<Reference>) -> Self {
        self.references = references;
        self
    }

    /// Sets the runtime-declared fields.
    #[must_use]
    pub fn with_runtime_fields(mut self, fields: Vec<FieldSpec>) -> Self {
        self.runtime_fields = Some(fields);
        self
    }
}