conformal_core 0.2.0

Code shared between wrappers in conformal framework.
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

use std::rc;

use conformal_component::parameters::{Info, Value};

pub trait Listener {
    fn parameter_changed(&self, unique_id: &str, value: &Value);
}

#[derive(Debug, Clone, PartialEq)]
pub enum SetError {
    NotFound,
    WrongType,
    InvalidValue,
    InternalError,
}

#[derive(Debug, Clone, PartialEq)]
pub enum SetGrabbedError {
    NotFound,
    InternalError,
}

pub trait Store {
    fn get(&self, unique_id: &str) -> Option<Value>;

    fn get_info(&self, unique_id: &str) -> Option<Info>;

    /// Set a parameter value
    ///
    /// # Errors
    ///
    ///  - Returns `NotFound` if the no parameter with the given `unique_id` is in the store.
    ///  - Returns `WrongType` if the parameter with the given `unique_id` does not have a type that matches `value`.
    ///  - Returns `InvalidValue` if the provided `value` is out of the valid range for the parameter with the given `unique_id`.
    ///  - Returns `InternalError` if the store is unable to set the value due to a bad internal state
    fn set(&mut self, unique_id: &str, value: Value) -> Result<(), SetError>;

    /// Set the "grabbed" state of a parameter.
    ///
    /// # Errors
    ///
    ///  - Returns `NotFound` if the no parameter with the given `unique_id` is in the store.
    ///  - Returns `InternalError` if the store is unable to set the value due to a bad internal state
    fn set_grabbed(&mut self, unique_id: &str, grabbed: bool) -> Result<(), SetGrabbedError>;

    /// Note that there can only be one listener at a time!
    fn set_listener(&mut self, listener: rc::Weak<dyn Listener>);
}