simengine 0.2.6

A plugin-based simulation engine runtime and plugin API
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

use crate::{plugin_api::SimContext, plugin_api::SimLogLevel};
use std::ffi::CString;

/// Clean API exposed to simulation authors.
#[derive(Debug, Copy, Clone)]
pub struct SimulationContext {
    raw: SimContext,
}

impl SimulationContext {
    pub fn from_raw(raw: SimContext) -> Self {
        Self { raw }
    }

    pub fn log(&self, level: SimLogLevel, message: impl AsRef<str>) {
        let message = CString::new(message.as_ref()).expect("log message contained a NUL byte");
        (self.raw.log)(self.raw.user_data, level, message.as_ptr());
    }

    pub fn info(&self, message: impl AsRef<str>) {
        self.log(SimLogLevel::Info, message);
    }

    pub fn set_output_bytes(&self, name: impl AsRef<str>, payload: &[u8]) {
        let name = CString::new(name.as_ref()).expect("output name contained a NUL byte");
        (self.raw.set_output)(
            self.raw.user_data,
            name.as_ptr(),
            payload.as_ptr(),
            payload.len(),
        );
    }

    pub fn set_output_f32(&self, name: impl AsRef<str>, value: f32) {
        self.set_output_bytes(name, &value.to_le_bytes());
    }

    pub fn get_input_bytes(&self, name: impl AsRef<str>, out: &mut [u8]) -> Option<usize> {
        let name = CString::new(name.as_ref()).expect("input name contained a NUL byte");
        let bytes_read = (self.raw.get_input)(
            self.raw.user_data,
            name.as_ptr(),
            out.as_mut_ptr(),
            out.len(),
        );

        if bytes_read == 0 {
            None
        } else {
            Some(bytes_read)
        }
    }

    pub fn get_input_f32(&self, name: impl AsRef<str>) -> Option<f32> {
        self.get_fixed_input(name).map(f32::from_le_bytes)
    }

    pub fn set_state(&self, state: impl AsRef<str>) {
        let state = CString::new(state.as_ref()).expect("state contained a NUL byte");
        (self.raw.set_state)(self.raw.user_data, state.as_ptr());
    }

    fn get_fixed_input<const N: usize>(&self, name: impl AsRef<str>) -> Option<[u8; N]> {
        let mut buffer = [0u8; N];
        match self.get_input_bytes(name, &mut buffer) {
            Some(bytes_read) if bytes_read == N => Some(buffer),
            _ => None,
        }
    }
}