wasserxr 0.2.1

A **dynamic XR Engine** to help you stay in the **flow**
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use std::{collections::HashMap, ffi::c_void};

use crate::{
    error::AssetError,
    scene::{
        assets::field::{Field, Getter},
        component::FieldType,
    },
};

/// Runtime schema for one asset type.
///
/// Asset schemas are filled by generated `wxr_asset_schema_<Asset>` functions
/// and later used by `Scene::asset_query`.
#[derive(Default)]
pub struct Schema {
    fields: HashMap<String, Field>,
}

impl Schema {
    #[cfg(test)]
    pub(crate) fn new() -> Self {
        Schema::default()
    }

    /// Registers one asset field in the schema.
    pub fn add_field(&mut self, id: String, type_hint: FieldType, getter: Option<Getter>) {
        let field = Field::new(type_hint, getter);
        self.fields.insert(id, field);
    }

    pub(crate) fn get_getter(&self, id: &str) -> Result<Getter, AssetError> {
        match self.fields.get(id) {
            Some(field) => field.get_getter(),
            None => Err(AssetError::FieldNotFound),
        }
    }

    /// Returns the type hint for a registered asset field.
    pub fn get_field_type(&self, id: &str) -> Result<FieldType, AssetError> {
        match self.fields.get(id) {
            Some(field) => Ok(field.get_type()),
            None => Err(AssetError::FieldNotFound),
        }
    }

    /// Returns all registered field ids.
    pub fn get_fields(&self) -> Vec<&String> {
        self.fields.keys().collect()
    }

    pub(crate) unsafe fn get_field_ptr(
        &self,
        id: &str,
        data: *mut c_void,
    ) -> Result<*mut c_void, AssetError> {
        let getter = self.get_getter(id)?;
        Ok(unsafe { getter(data) })
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    unsafe extern "C" fn test_getter(_data: *mut c_void) -> *mut c_void {
        std::ptr::null_mut()
    }

    #[test]
    fn schema_add_field() {
        let mut schema = Schema::new();

        schema.add_field("content".to_owned(), FieldType::String, Some(test_getter));

        let fields = schema.get_fields();
        assert_eq!(fields.len(), 1);
        assert_eq!(fields[0], "content");
    }

    #[test]
    fn schema_get_getter_for_existing_field() {
        let mut schema = Schema::new();

        schema.add_field("content".to_owned(), FieldType::String, Some(test_getter));

        assert_eq!(
            schema.get_getter("content").unwrap() as usize,
            test_getter as *const () as usize
        );
    }

    #[test]
    fn schema_get_getter_for_missing_field() {
        let schema = Schema::new();

        assert_eq!(schema.get_getter("content"), Err(AssetError::FieldNotFound));
    }

    #[test]
    fn schema_get_field_type() {
        let mut schema = Schema::new();

        schema.add_field("content".to_owned(), FieldType::String, Some(test_getter));

        assert_eq!(schema.get_field_type("content"), Ok(FieldType::String));
    }
}