wfe-core 1.9.2

Core traits, models, builder, and executor for the WFE workflow engine
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

use async_trait::async_trait;

use crate::models::WorkflowInstance;

/// Result from a search query.
#[derive(Debug, Clone)]
pub struct WorkflowSearchResult {
    /// Id.
    pub id: String,
    /// Workflow definition id.
    pub workflow_definition_id: String,
    /// Version.
    pub version: u32,
    /// Status.
    pub status: crate::models::WorkflowStatus,
    /// Reference.
    pub reference: Option<String>,
    /// Description.
    pub description: Option<String>,
}

/// Filter for search queries.
#[derive(Debug, Clone)]
pub enum SearchFilter {
    /// Status.
    Status(crate::models::WorkflowStatus),
    /// Daterange.
    DateRange {
        field: String,
        before: Option<chrono::DateTime<chrono::Utc>>,
        after: Option<chrono::DateTime<chrono::Utc>>,
    },
    /// Reference.
    Reference(String),
}

/// Paginated search results.
#[derive(Debug, Clone)]
pub struct Page<T> {
    /// Data.
    pub data: Vec<T>,
    /// Total.
    pub total: u64,
}

/// Search index for querying workflows.
#[async_trait]
pub trait SearchIndex: Send + Sync {
    async fn index_workflow(&self, instance: &WorkflowInstance) -> crate::Result<()>;
    async fn search(
        &self,
        terms: &str,
        skip: u64,
        take: u64,
        filters: &[SearchFilter],
    ) -> crate::Result<Page<WorkflowSearchResult>>;
    async fn start(&self) -> crate::Result<()>;
    async fn stop(&self) -> crate::Result<()>;
}