auxon-sdk 2.3.0

A collection of clients, servers, protocols, and general API types for interacting with the APIs that are used throughout Auxon's suite of tools
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

use async_trait::async_trait;

use crate::api::{AttrKey, AttrVal};
use std::collections::BTreeMap;

/// "Infallible" operational view on a mutator actuator.
#[async_trait]
pub trait MutatorActuator {
    /// Input params attribute iterator should not contain duplicate keys.
    /// It is effectively a map of key-value pairs.
    ///
    /// The keys are expected to be of either format:
    ///   * `<param-key>`
    ///   * OR `mutator.params.<param-key>`
    async fn inject(
        &mut self,
        mutation_id: uuid::Uuid,
        params: BTreeMap<AttrKey, AttrVal>,
    ) -> Result<(), Box<dyn std::error::Error + Send + Sync>>;

    async fn reset(&mut self) -> Result<(), Box<dyn std::error::Error + Send + Sync>>;
}

/// A non-async version of MutatorActuator. This isn't supported by the provided http server, but
/// may be useful if the abstraction is needed in other host contexts.
pub trait SyncMutatorActuator {
    /// Input params attribute iterator should not contain duplicate keys.
    /// It is effectively a map of key-value pairs.
    ///
    /// The keys are expected to be of either format:
    ///   * `<param-key>`
    ///   * OR `mutator.params.<param-key>`
    fn inject(
        &mut self,
        mutation_id: uuid::Uuid,
        params: BTreeMap<AttrKey, AttrVal>,
    ) -> Result<(), Box<dyn std::error::Error>>;

    fn reset(&mut self) -> Result<(), Box<dyn std::error::Error>>;
}