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 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
// Copyright (c) 2020-2021 Thomas Kramer.
// SPDX-FileCopyrightText: 2022 Thomas Kramer
//
// SPDX-License-Identifier: AGPL-3.0-or-later
//! Container structs for user defined properties.
use crate::rc_string::RcString;
use std::borrow::Borrow;
use std::collections::HashMap;
use std::convert::TryInto;
use std::hash::Hash;
use std::sync::Arc;
// trait AnyValue: Any + Clone + std::fmt::Debug {}
/// Property value type.
/// Properties can hold different types that are encapsulated in this enum.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub enum PropertyValue {
/// Property is a string.
String(RcString),
/// Property is a byte string.
Bytes(Vec<u8>),
/// Property is a signed integer.
SInt(i32),
/// Property is an unsigned integer.
UInt(u32),
/// Property is a float.
Float(f64),
// /// Dynamically typed value.
// Any(Box<dyn AnyValue>),
}
impl PropertyValue {
/// Try to get a string value.
pub fn get_string(&self) -> Option<RcString> {
match self {
PropertyValue::String(s) => Some(s.clone()),
_ => None,
}
}
/// Try to get a `&str` value. Works for `String` property values.
pub fn get_str(&self) -> Option<&str> {
match self {
PropertyValue::String(s) => Some(s.as_str()),
_ => None,
}
}
/// Try to get a byte string value.
pub fn get_bytes(&self) -> Option<&Vec<u8>> {
match self {
PropertyValue::Bytes(s) => Some(s),
_ => None,
}
}
/// Try to get a float value.
pub fn get_float(&self) -> Option<f64> {
match self {
PropertyValue::Float(v) => Some(*v),
_ => None,
}
}
/// Try to get an i32 value.
pub fn get_sint(&self) -> Option<i32> {
match self {
PropertyValue::SInt(v) => Some(*v),
_ => None,
}
}
/// Try to get an i32 value.
pub fn get_uint(&self) -> Option<u32> {
match self {
PropertyValue::UInt(v) => Some(*v),
_ => None,
}
}
// /// Try to get a dynamically typed value.
// pub fn get_any(&self) -> Option<&Box<dyn AnyValue>> {
// match self {
// PropertyValue::Any(v) => Some(v),
// _ => None
// }
// }
}
// pub enum PropertyKey {
// String(String),
//
// }
impl From<String> for PropertyValue {
fn from(v: String) -> Self {
PropertyValue::String(v.into())
}
}
impl From<Arc<String>> for PropertyValue {
fn from(v: Arc<String>) -> Self {
PropertyValue::String(v.into())
}
}
impl From<&Arc<String>> for PropertyValue {
fn from(v: &Arc<String>) -> Self {
PropertyValue::String(v.into())
}
}
impl From<&str> for PropertyValue {
fn from(v: &str) -> Self {
PropertyValue::String(v.into())
}
}
impl From<Vec<u8>> for PropertyValue {
fn from(v: Vec<u8>) -> Self {
PropertyValue::Bytes(v)
}
}
impl<'a> TryInto<&'a str> for &'a PropertyValue {
type Error = ();
fn try_into(self) -> Result<&'a str, Self::Error> {
if let PropertyValue::String(s) = self {
Ok(s.as_str())
} else {
Err(())
}
}
}
impl From<i32> for PropertyValue {
fn from(v: i32) -> Self {
PropertyValue::SInt(v)
}
}
impl TryInto<i32> for &PropertyValue {
type Error = ();
fn try_into(self) -> Result<i32, Self::Error> {
if let PropertyValue::SInt(v) = self {
Ok(*v)
} else {
Err(())
}
}
}
impl From<u32> for PropertyValue {
fn from(v: u32) -> Self {
PropertyValue::UInt(v)
}
}
impl From<f64> for PropertyValue {
fn from(v: f64) -> Self {
PropertyValue::Float(v)
}
}
// impl From<Box<dyn Any>> for PropertyValue {
// fn from(v: Box<dyn Any>) -> Self {
// PropertyValue::Any(v)
// }
// }
/// Look-up table for property values.
#[derive(Debug, Clone)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct PropertyStore<K>
where
K: Hash + Eq,
{
content: HashMap<K, PropertyValue>,
}
impl<K: Hash + Eq> Default for PropertyStore<K> {
fn default() -> Self {
Self::new()
}
}
impl<K: Hash + Eq> PropertyStore<K> {
/// Create an empty property store.
pub fn new() -> Self {
PropertyStore {
content: HashMap::new(),
}
}
/// Insert a property.
/// Returns the old property value if there was already a property stored under this key.
pub fn insert<V: Into<PropertyValue>>(&mut self, key: K, value: V) -> Option<PropertyValue> {
self.content.insert(key, value.into())
}
/// Get a property value by the property key.
pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&PropertyValue>
where
K: Borrow<Q>,
Q: Eq + Hash,
{
self.content.get(key)
}
/// Check if the `key` is contained in this property store.
pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool
where
K: Borrow<Q>,
Q: Eq + Hash,
{
self.content.contains_key(key)
}
/// Get a string property value by key.
/// If the property value is not a string `None` is returned.
pub fn get_string<Q: ?Sized>(&self, key: &Q) -> Option<&RcString>
where
K: Borrow<Q>,
Q: Eq + Hash,
{
self.get(key).and_then(|v| {
if let PropertyValue::String(s) = v {
Some(s)
} else {
None
}
})
}
}
/// A trait for associating user defined properties with a type.
pub trait WithProperties {
/// Property key type.
type Key: Hash + Eq;
/// Call a function with maybe the property storage as argument.
///
/// The property store might not always be initialized. For instance for
/// objects without any defined properties, it will likely be `None`.
fn with_properties<F, R>(&self, f: F) -> R
where
F: FnOnce(Option<&PropertyStore<Self::Key>>) -> R;
/// Get mutable reference to the property storage.
fn with_properties_mut<F, R>(&self, f: F) -> R
where
F: FnOnce(&mut PropertyStore<Self::Key>) -> R;
/// Get a property value by the property key.
fn property<Q: ?Sized>(&self, key: &Q) -> Option<PropertyValue>
where
Self::Key: Borrow<Q>,
Q: Eq + Hash,
{
self.with_properties(|p| p.and_then(|p| p.get(key).cloned()))
}
/// Get a string property value by key.
/// If the property value is not a string `None` is returned.
fn property_str<Q: ?Sized>(&self, key: &Q) -> Option<RcString>
where
Self::Key: Borrow<Q>,
Q: Eq + Hash,
{
self.with_properties(|p| p.and_then(|p| p.get_string(key).cloned()))
}
/// Insert a property.
/// Returns the old property value if there was already a property stored under this key.
fn set_property<V: Into<PropertyValue>>(
&self,
key: Self::Key,
value: V,
) -> Option<PropertyValue> {
self.with_properties_mut(|p| p.insert(key, value))
}
}