wirerust 0.1.0

A modular, embeddable filter engine for structured data
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
109
110
111
112
113
114
115
116
117
118

//! Schema module: defines the field/type registry for filters.
//!
//! This module provides the FilterSchema type and builder for defining available fields and types.

use crate::types::FieldType;
use serde::{Deserialize, Serialize};
use std::collections::HashMap;

#[derive(Debug, Clone, Serialize, Deserialize)]
#[non_exhaustive]
pub struct FilterSchema {
    fields: HashMap<String, FieldType>,
    field_names: Vec<String>,          // index = FieldId
    field_ids: HashMap<String, usize>, // name -> id
}

impl FilterSchema {
    pub fn get_field_type(&self, name: &str) -> Option<&FieldType> {
        self.fields.get(name)
    }
    pub fn fields(&self) -> &HashMap<String, FieldType> {
        &self.fields
    }
    /// Get the field ID for a given field name, if it exists.
    pub fn field_id(&self, name: &str) -> Option<usize> {
        self.field_ids.get(name).copied()
    }
    /// Get the field name for a given field ID, if it exists.
    pub fn field_name(&self, id: usize) -> Option<&str> {
        self.field_names.get(id).map(|s| s.as_str())
    }
    /// Get the total number of fields.
    pub fn num_fields(&self) -> usize {
        self.field_names.len()
    }
}

#[derive(Debug, Default, Serialize, Deserialize)]
pub struct FilterSchemaBuilder {
    fields: HashMap<String, FieldType>,
}

impl FilterSchemaBuilder {
    pub fn new() -> Self {
        Self {
            fields: HashMap::new(),
        }
    }
    pub fn field(mut self, name: impl Into<String>, ty: FieldType) -> Self {
        self.fields.insert(name.into(), ty);
        self
    }
    pub fn build(self) -> FilterSchema {
        let mut field_names = Vec::new();
        let mut field_ids = HashMap::new();
        let mut sorted_names: Vec<_> = self.fields.keys().cloned().collect();
        sorted_names.sort();
        for name in sorted_names {
            field_ids.insert(name.clone(), field_names.len());
            field_names.push(name);
        }
        FilterSchema {
            fields: self.fields,
            field_names,
            field_ids,
        }
    }
}

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

    #[test]
    fn test_field_registration_and_retrieval() {
        let schema = FilterSchemaBuilder::new()
            .field("foo", FieldType::Int)
            .field("bar", FieldType::Bytes)
            .build();
        assert_eq!(schema.get_field_type("foo"), Some(&FieldType::Int));
        assert_eq!(schema.get_field_type("bar"), Some(&FieldType::Bytes));
        assert_eq!(schema.get_field_type("baz"), None);
    }

    #[test]
    fn test_fields_map() {
        let schema = FilterSchemaBuilder::new()
            .field("foo", FieldType::Int)
            .field("bar", FieldType::Bytes)
            .build();
        let fields = schema.fields();
        assert_eq!(fields.len(), 2);
        assert!(fields.contains_key("foo"));
        assert!(fields.contains_key("bar"));
    }

    #[test]
    fn test_schema_serialization_deserialization() {
        let schema = FilterSchemaBuilder::new()
            .field("foo", FieldType::Int)
            .field("bar", FieldType::Array(Box::new(FieldType::Bytes)))
            .build();
        let json = serde_json::to_string(&schema).unwrap();
        let deserialized: FilterSchema = serde_json::from_str(&json).unwrap();
        assert_eq!(schema.fields(), deserialized.fields());
    }

    #[test]
    fn test_schema_builder_overwrite_field() {
        let schema = FilterSchemaBuilder::new()
            .field("foo", FieldType::Int)
            .field("foo", FieldType::Bytes)
            .build();
        // Last one wins
        assert_eq!(schema.get_field_type("foo"), Some(&FieldType::Bytes));
    }
}