ply-engine 1.0.3

The most powerful app engine made entirely in Rust
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

use crate::engine;

/// Owned string for debug/display purposes.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct StringId {
    text: String,
}

impl StringId {
    pub fn from_str(s: &str) -> Self {
        Self {
            text: s.to_string(),
        }
    }

    pub fn empty() -> Self {
        Self::default()
    }

    /// Get the string content.
    pub fn as_str(&self) -> &str {
        &self.text
    }

    /// Returns true if the string is empty.
    pub fn is_empty(&self) -> bool {
        self.text.is_empty()
    }
}

/// A hashed identifier used to uniquely address UI elements across frames.
#[derive(Debug, Clone, Default, PartialEq)]
pub struct Id {
    pub id: u32,
    pub offset: u32,
    pub base_id: u32,
    pub string_id: StringId,
}

impl Id {
    /// Creates a ply id using the `label`
    #[inline]
    pub fn new(label: &'static str) -> Id {
        Self::new_index(label, 0)
    }

    /// Creates a ply id using the `label` and the `index`
    #[inline]
    pub fn new_index(label: &'static str, index: u32) -> Id {
        engine::hash_string_with_offset(label, index, 0)
    }

    #[inline]
    pub fn new_index_seed(label: &'static str, index: u32, seed: u32) -> Id {
        engine::hash_string_with_offset(label, index, seed)
    }
}

impl From<&'static str> for Id {
    fn from(label: &'static str) -> Self {
        Id::new(label)
    }
}

impl From<(&str, u32)> for Id {
    fn from((label, offset): (&str, u32)) -> Self {
        engine::hash_string_with_offset(label, offset, 0)
    }
}

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

    #[test]
    fn from_str_matches_new() {
        let a = Id::from("hello");
        let b = Id::new("hello");
        assert_eq!(a.id, b.id);
        assert_eq!(a.base_id, b.base_id);
    }

    #[test]
    fn from_tuple_matches_new_index() {
        let a = Id::from(("my_button", 3));
        let b = Id::new_index("my_button", 3);
        assert_eq!(a.id, b.id);
        assert_eq!(a.offset, b.offset);
        assert_eq!(a.base_id, b.base_id);
    }

    #[test]
    fn from_tuple_zero_offset_matches_from_str() {
        let a = Id::from(("test", 0));
        let b = Id::from("test");
        assert_eq!(a.id, b.id);
    }

    #[test]
    fn different_offsets_produce_different_ids() {
        let a = Id::from(("item", 0));
        let b = Id::from(("item", 1));
        assert_ne!(a.id, b.id);
        // But base_id should be the same (pre-offset hash)
        assert_eq!(a.base_id, b.base_id);
    }
}