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 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
|
//! JSON type representations for schema validation.
//!
//! Provides [`JsonType`] for individual types and [`JsonTypeSet`] for efficient
//! bitset-based type checking in validation hot paths.
use core::fmt;
use std::str::FromStr;
use serde_json::Value;
/// Represents a JSON value type.
#[derive(Debug, Clone, Copy, Eq, PartialEq, Hash)]
#[repr(u8)]
pub enum JsonType {
Array = 1 << 0,
Boolean = 1 << 1,
Integer = 1 << 2,
Null = 1 << 3,
Number = 1 << 4,
Object = 1 << 5,
String = 1 << 6,
}
impl fmt::Display for JsonType {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
JsonType::Array => f.write_str("array"),
JsonType::Boolean => f.write_str("boolean"),
JsonType::Integer => f.write_str("integer"),
JsonType::Null => f.write_str("null"),
JsonType::Number => f.write_str("number"),
JsonType::Object => f.write_str("object"),
JsonType::String => f.write_str("string"),
}
}
}
impl JsonType {
pub(crate) fn from_repr(repr: u8) -> Self {
match repr {
1 => JsonType::Array,
2 => JsonType::Boolean,
4 => JsonType::Integer,
8 => JsonType::Null,
16 => JsonType::Number,
32 => JsonType::Object,
64 => JsonType::String,
_ => panic!("Invalid JsonType representation: {repr}"),
}
}
}
impl From<&Value> for JsonType {
fn from(instance: &Value) -> Self {
match instance {
Value::Null => JsonType::Null,
Value::Bool(_) => JsonType::Boolean,
Value::Number(_) => JsonType::Number,
Value::String(_) => JsonType::String,
Value::Array(_) => JsonType::Array,
Value::Object(_) => JsonType::Object,
}
}
}
impl FromStr for JsonType {
type Err = ();
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s {
"array" => Ok(JsonType::Array),
"boolean" => Ok(JsonType::Boolean),
"integer" => Ok(JsonType::Integer),
"null" => Ok(JsonType::Null),
"number" => Ok(JsonType::Number),
"object" => Ok(JsonType::Object),
"string" => Ok(JsonType::String),
_ => Err(()),
}
}
}
/// A set of JSON types.
#[derive(Clone, Copy, Eq, PartialEq, Hash)]
pub struct JsonTypeSet(u8);
impl Default for JsonTypeSet {
fn default() -> Self {
Self::empty()
}
}
impl JsonTypeSet {
/// Create an empty set of types.
#[inline]
#[must_use]
pub const fn empty() -> Self {
Self(0)
}
/// Create a set with all possible JSON types.
#[inline]
#[must_use]
pub const fn all() -> Self {
JsonTypeSet::empty()
.insert(JsonType::Null)
.insert(JsonType::Boolean)
.insert(JsonType::Integer)
.insert(JsonType::Number)
.insert(JsonType::String)
.insert(JsonType::Array)
.insert(JsonType::Object)
}
/// Add a type to this set and return the modified set.
#[inline]
#[must_use]
pub const fn insert(mut self, ty: JsonType) -> Self {
self.0 |= ty as u8;
self
}
/// Remove a type from this set and return the modified set.
#[inline]
#[must_use]
pub const fn remove(mut self, ty: JsonType) -> Self {
self.0 &= !(ty as u8);
self
}
/// Return the number of types in this set.
#[inline]
#[must_use]
pub const fn len(self) -> usize {
self.0.count_ones() as usize
}
/// Return `true` if the set contains no types.
#[inline]
#[must_use]
pub const fn is_empty(self) -> bool {
self.0 == 0
}
/// Check if this set includes the specified type.
#[inline]
#[must_use]
pub fn contains(self, ty: JsonType) -> bool {
self.0 & ty as u8 != 0
}
/// Check if a JSON value's type is allowed by this set.
#[must_use]
pub fn contains_value_type(self, value: &Value) -> bool {
match value {
Value::Array(_) => self.contains(JsonType::Array),
Value::Bool(_) => self.contains(JsonType::Boolean),
Value::Null => self.contains(JsonType::Null),
Value::Number(n) => {
#[cfg(feature = "arbitrary-precision")]
{
use crate::ext::numeric::bignum;
use num_traits::One;
// Check if the number is an integer using the same logic as is_integer()
// Important: Check BigFraction BEFORE as_f64() to avoid precision loss
let is_integer = n.is_i64() || n.is_u64() || {
// Check huge plain integers first
if bignum::try_parse_bigint(n).is_some() {
true
} else if let Some(bigfrac) = bignum::try_parse_bigfraction(n) {
// Check if denominator is 1 (integer value)
bigfrac.denom().is_none_or(One::is_one)
} else if let Some(f) = n.as_f64() {
// For numbers in f64 range
f.fract() == 0.
} else {
// Numbers that overflow to infinity (as_f64() returns None)
false
}
};
if is_integer {
self.contains(JsonType::Integer) || self.contains(JsonType::Number)
} else {
self.contains(JsonType::Number)
}
}
#[cfg(not(feature = "arbitrary-precision"))]
{
let is_integer = if n.is_i64() || n.is_u64() {
true
} else if let Some(f) = n.as_f64() {
f.fract() == 0.
} else {
unreachable!(
"Numbers always fit in u64/i64/f64 without arbitrary-precision"
)
};
if is_integer {
// Integer numbers match either Integer or Number types
self.contains(JsonType::Integer) || self.contains(JsonType::Number)
} else {
// Floating-point numbers only match Number type
self.contains(JsonType::Number)
}
}
}
Value::Object(_) => self.contains(JsonType::Object),
Value::String(_) => self.contains(JsonType::String),
}
}
/// Get an iterator over the types in this set.
#[inline]
#[must_use]
pub fn iter(&self) -> JsonTypeSetIterator {
JsonTypeSetIterator { set: *self }
}
}
impl IntoIterator for &JsonTypeSet {
type Item = JsonType;
type IntoIter = JsonTypeSetIterator;
fn into_iter(self) -> Self::IntoIter {
self.iter()
}
}
impl IntoIterator for JsonTypeSet {
type Item = JsonType;
type IntoIter = JsonTypeSetIterator;
fn into_iter(self) -> Self::IntoIter {
JsonTypeSetIterator { set: self }
}
}
impl fmt::Debug for JsonTypeSet {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "(")?;
let mut iter = self.iter();
if let Some(ty) = iter.next() {
write!(f, "{ty}")?;
}
for ty in iter {
write!(f, ", {ty}")?;
}
write!(f, ")")
}
}
/// Iterator for traversing the types in a `JsonTypeSet`.
#[derive(Debug)]
pub struct JsonTypeSetIterator {
set: JsonTypeSet,
}
impl Iterator for JsonTypeSetIterator {
type Item = JsonType;
fn next(&mut self) -> Option<Self::Item> {
if self.set.0 == 0 {
None
} else {
// Find the least significant bit that is set
let lsb = self.set.0 & self.set.0.wrapping_neg();
// Clear the least significant bit
self.set.0 &= self.set.0 - 1;
Some(JsonType::from_repr(lsb))
}
}
fn size_hint(&self) -> (usize, Option<usize>) {
let count = self.set.0.count_ones() as usize;
(count, Some(count))
}
}
impl ExactSizeIterator for JsonTypeSetIterator {}
#[deprecated(since = "0.30.0", note = "Use `jsonschema::JsonType` instead.")]
pub type PrimitiveType = JsonType;
#[deprecated(since = "0.30.0", note = "Use `jsonschema::JsonTypeSet` instead.")]
pub type PrimitiveTypesBitMap = JsonTypeSet;
#[cfg(test)]
mod tests {
use super::*;
use serde_json::json;
use test_case::test_case;
#[test_case("array" => Ok(JsonType::Array) ; "parse array")]
#[test_case("boolean" => Ok(JsonType::Boolean) ; "parse boolean")]
#[test_case("integer" => Ok(JsonType::Integer) ; "parse integer")]
#[test_case("null" => Ok(JsonType::Null) ; "parse null")]
#[test_case("number" => Ok(JsonType::Number) ; "parse number")]
#[test_case("object" => Ok(JsonType::Object) ; "parse object")]
#[test_case("string" => Ok(JsonType::String) ; "parse string")]
#[test_case("invalid" => Err(()) ; "parse invalid")]
fn test_from_str(input: &str) -> Result<JsonType, ()> {
JsonType::from_str(input)
}
#[test_case(JsonType::Array => "array" ; "display array")]
#[test_case(JsonType::Boolean => "boolean" ; "display boolean")]
#[test_case(JsonType::Integer => "integer" ; "display integer")]
#[test_case(JsonType::Null => "null" ; "display null")]
#[test_case(JsonType::Number => "number" ; "display number")]
#[test_case(JsonType::Object => "object" ; "display object")]
#[test_case(JsonType::String => "string" ; "display string")]
fn test_display(json_type: JsonType) -> String {
json_type.to_string()
}
#[test_case(&json!(null) => JsonType::Null ; "value null")]
#[test_case(&json!(true) => JsonType::Boolean ; "value boolean")]
#[test_case(&json!(42) => JsonType::Number ; "value number int")]
#[test_case(&json!(1.12) => JsonType::Number ; "value number float")]
#[test_case(&json!("hello") => JsonType::String ; "value string")]
#[test_case(&json!([1, 2, 3]) => JsonType::Array ; "value array")]
#[test_case(&json!({"key": "value"}) => JsonType::Object ; "value object")]
fn test_from_value(value: &Value) -> JsonType {
JsonType::from(value)
}
#[test]
fn test_insert_types() {
let mut set = JsonTypeSet::empty();
set = set.insert(JsonType::String);
assert!(set.contains(JsonType::String));
assert!(!set.contains(JsonType::Number));
set = set.insert(JsonType::Number);
assert!(set.contains(JsonType::String));
assert!(set.contains(JsonType::Number));
assert!(!set.contains(JsonType::Array));
}
#[test_case(&json!(null), JsonTypeSet::empty().insert(JsonType::Null) => true ; "null type")]
#[test_case(&json!(true), JsonTypeSet::empty().insert(JsonType::Boolean) => true ; "boolean type")]
#[test_case(&json!("test"), JsonTypeSet::empty().insert(JsonType::String) => true ; "string type")]
#[test_case(&json!([1,2]), JsonTypeSet::empty().insert(JsonType::Array) => true ; "array type")]
#[test_case(&json!({"a": 1}), JsonTypeSet::empty().insert(JsonType::Object) => true ; "object type")]
#[test_case(&json!(42), JsonTypeSet::empty().insert(JsonType::Number) => true ; "number matches number")]
#[test_case(&json!(42), JsonTypeSet::empty().insert(JsonType::Integer) => true ; "int matches integer")]
#[test_case(&json!(1.23), JsonTypeSet::empty().insert(JsonType::Number) => true ; "float matches number")]
#[test_case(&json!(1.23), JsonTypeSet::empty().insert(JsonType::Integer) => false ; "float doesn't match integer")]
fn test_contains_value_type(value: &Value, set: JsonTypeSet) -> bool {
set.contains_value_type(value)
}
#[test]
fn test_remove_types() {
let set = JsonTypeSet::all().remove(JsonType::Number);
assert!(!set.contains(JsonType::Number));
assert!(set.contains(JsonType::Integer));
assert_eq!(set.len(), 6);
let empty = JsonTypeSet::empty();
assert_eq!(empty.remove(JsonType::Boolean), empty);
}
#[test]
fn test_len() {
let empty = JsonTypeSet::empty();
assert!(empty.is_empty());
assert_eq!(empty.len(), 0);
let with_string = empty.insert(JsonType::String);
assert!(!with_string.is_empty());
assert_eq!(with_string.len(), 1);
assert_eq!(JsonTypeSet::all().len(), 7);
}
#[test]
fn test_debug_format() {
assert_eq!(format!("{:?}", JsonTypeSet::default()), "()");
assert_eq!(
format!("{:?}", JsonTypeSet::empty().insert(JsonType::String)),
"(string)"
);
assert_eq!(
format!(
"{:?}",
JsonTypeSet::empty()
.insert(JsonType::String)
.insert(JsonType::Number)
),
"(number, string)"
);
}
#[test]
fn test_empty_iterator() {
let set = JsonTypeSet::empty();
let mut iter = set.iter();
assert_eq!(iter.next(), None);
assert_eq!(iter.size_hint(), (0, Some(0)));
}
#[test]
fn test_single_type_iterator() {
let set = JsonTypeSet::empty().insert(JsonType::String);
let mut iter = set.iter();
assert_eq!(iter.size_hint(), (1, Some(1)));
assert_eq!(iter.next(), Some(JsonType::String));
assert_eq!(iter.size_hint(), (0, Some(0)));
assert_eq!(iter.next(), None);
assert_eq!(iter.size_hint(), (0, Some(0)));
}
#[test]
fn test_multiple_types_iterator() {
let set = JsonTypeSet::empty()
.insert(JsonType::String)
.insert(JsonType::Number)
.insert(JsonType::Boolean);
let types: Vec<JsonType> = set.iter().collect();
assert_eq!(types.len(), 3);
assert!(types.contains(&JsonType::String));
assert!(types.contains(&JsonType::Number));
assert!(types.contains(&JsonType::Boolean));
assert_eq!(set.iter().size_hint(), (3, Some(3)));
}
#[test]
fn test_all_types_iterator() {
let set = JsonTypeSet::all();
let types: Vec<JsonType> = set.iter().collect();
assert_eq!(types.len(), 7);
let mut iter = set.iter();
assert_eq!(iter.len(), 7);
iter.next();
assert_eq!(iter.len(), 6);
}
}
|