Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for arbitrary-int #303

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ println!("{}", serde_json::to_string_pretty(&schema).unwrap());

Schemars can implement `JsonSchema` on types from several popular crates, enabled via feature flags (dependency versions are shown in brackets):

- `arbitrary_int` - [arbitrary-int](https://crates.io/crates/arbitrary-int) (^1.2.7)
- `chrono` - [chrono](https://crates.io/crates/chrono) (^0.4)
- `indexmap1` - [indexmap](https://crates.io/crates/indexmap) (^1.2)
- `indexmap2` - [indexmap](https://crates.io/crates/indexmap) (^2.0)
Expand Down
6 changes: 6 additions & 0 deletions schemars/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0.25"
dyn-clone = "1.0"

arbitrary-int = { version = "1.2.7", default-features = false, optional = true }
chrono = { version = "0.4", default-features = false, optional = true }
indexmap = { version = "1.2", features = ["serde-1"], optional = true }
indexmap2 = { version = "2.0", features = ["serde"], optional = true, package = "indexmap" }
Expand Down Expand Up @@ -55,6 +56,7 @@ impl_json_schema = ["derive"]
# derive_json_schema will be removed in a later version
derive_json_schema = ["impl_json_schema"]

arbitrary_int = ["arbitrary-int"]
# `uuid` feature contains `uuid08` only for back-compat - will be changed to include uuid 1.0 instead in a later version
uuid = ["uuid08"]
# `arrayvec` feature without version suffix is included only for back-compat - will be removed in a later version
Expand All @@ -67,6 +69,10 @@ bigdecimal = ["bigdecimal03"]

ui_test = []

[[test]]
name = "arbitrary_int"
required-features = ["arbitrary_int"]

[[test]]
name = "chrono"
required-features = ["chrono"]
Expand Down
160 changes: 160 additions & 0 deletions schemars/src/json_schema_impls/arbitrary_int.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
use crate::gen::SchemaGenerator;
use crate::schema::*;
use crate::JsonSchema;
use std::borrow::Cow;

// We need almost everything.
// Only thing we don't is the struct [`arbitrary_int::TryNewError`].
// But this is more legible this way and LTO can optimise away for size anyway.
use arbitrary_int::*;

macro_rules! arbitrary_int_impl
{
($type:ty => $primitive:ty) => {
impl JsonSchema for $type {
no_ref_schema!();

fn schema_name() -> String {
stringify!($type).to_owned()
}

fn schema_id() -> Cow<'static, str> {
Cow::Borrowed(stringify!(std::num::$type))
}

fn json_schema(gen: &mut SchemaGenerator) -> Schema {
let mut schema: SchemaObject = <$primitive>::json_schema(gen).into();
schema.number().maximum = Some(<$type>::MAX.value() as f64);
schema.into()
}
}
}
}

// Maybe we can do a macro to generate 1->127?
// Would have to skip every power of 2.
// Not sure if it's worth when this work.

arbitrary_int_impl!(u1 => u8);
arbitrary_int_impl!(u2 => u8);
arbitrary_int_impl!(u3 => u8);
arbitrary_int_impl!(u4 => u8);
arbitrary_int_impl!(u5 => u8);
arbitrary_int_impl!(u6 => u8);
arbitrary_int_impl!(u7 => u8);
arbitrary_int_impl!(u9 => u16);
arbitrary_int_impl!(u10 => u16);
arbitrary_int_impl!(u11 => u16);
arbitrary_int_impl!(u12 => u16);
arbitrary_int_impl!(u13 => u16);
arbitrary_int_impl!(u14 => u16);
arbitrary_int_impl!(u15 => u16);
arbitrary_int_impl!(u17 => u32);
arbitrary_int_impl!(u18 => u32);
arbitrary_int_impl!(u19 => u32);
arbitrary_int_impl!(u20 => u32);
arbitrary_int_impl!(u21 => u32);
arbitrary_int_impl!(u22 => u32);
arbitrary_int_impl!(u23 => u32);
arbitrary_int_impl!(u24 => u32);
arbitrary_int_impl!(u25 => u32);
arbitrary_int_impl!(u26 => u32);
arbitrary_int_impl!(u27 => u32);
arbitrary_int_impl!(u28 => u32);
arbitrary_int_impl!(u29 => u32);
arbitrary_int_impl!(u30 => u32);
arbitrary_int_impl!(u31 => u32);
arbitrary_int_impl!(u33 => u64);
arbitrary_int_impl!(u34 => u64);
arbitrary_int_impl!(u35 => u64);
arbitrary_int_impl!(u36 => u64);
arbitrary_int_impl!(u37 => u64);
arbitrary_int_impl!(u38 => u64);
arbitrary_int_impl!(u39 => u64);
arbitrary_int_impl!(u40 => u64);
arbitrary_int_impl!(u41 => u64);
arbitrary_int_impl!(u42 => u64);
arbitrary_int_impl!(u43 => u64);
arbitrary_int_impl!(u44 => u64);
arbitrary_int_impl!(u45 => u64);
arbitrary_int_impl!(u46 => u64);
arbitrary_int_impl!(u47 => u64);
arbitrary_int_impl!(u48 => u64);
arbitrary_int_impl!(u49 => u64);
arbitrary_int_impl!(u50 => u64);
arbitrary_int_impl!(u51 => u64);
arbitrary_int_impl!(u52 => u64);
arbitrary_int_impl!(u53 => u64);
arbitrary_int_impl!(u54 => u64);
arbitrary_int_impl!(u55 => u64);
arbitrary_int_impl!(u56 => u64);
arbitrary_int_impl!(u57 => u64);
arbitrary_int_impl!(u58 => u64);
arbitrary_int_impl!(u59 => u64);
arbitrary_int_impl!(u60 => u64);
arbitrary_int_impl!(u61 => u64);
arbitrary_int_impl!(u62 => u64);
arbitrary_int_impl!(u63 => u64);
arbitrary_int_impl!(u65 => u128);
arbitrary_int_impl!(u66 => u128);
arbitrary_int_impl!(u67 => u128);
arbitrary_int_impl!(u68 => u128);
arbitrary_int_impl!(u69 => u128);
arbitrary_int_impl!(u70 => u128);
arbitrary_int_impl!(u71 => u128);
arbitrary_int_impl!(u72 => u128);
arbitrary_int_impl!(u73 => u128);
arbitrary_int_impl!(u74 => u128);
arbitrary_int_impl!(u75 => u128);
arbitrary_int_impl!(u76 => u128);
arbitrary_int_impl!(u77 => u128);
arbitrary_int_impl!(u78 => u128);
arbitrary_int_impl!(u79 => u128);
arbitrary_int_impl!(u80 => u128);
arbitrary_int_impl!(u81 => u128);
arbitrary_int_impl!(u82 => u128);
arbitrary_int_impl!(u83 => u128);
arbitrary_int_impl!(u84 => u128);
arbitrary_int_impl!(u85 => u128);
arbitrary_int_impl!(u86 => u128);
arbitrary_int_impl!(u87 => u128);
arbitrary_int_impl!(u88 => u128);
arbitrary_int_impl!(u89 => u128);
arbitrary_int_impl!(u90 => u128);
arbitrary_int_impl!(u91 => u128);
arbitrary_int_impl!(u92 => u128);
arbitrary_int_impl!(u93 => u128);
arbitrary_int_impl!(u94 => u128);
arbitrary_int_impl!(u95 => u128);
arbitrary_int_impl!(u96 => u128);
arbitrary_int_impl!(u97 => u128);
arbitrary_int_impl!(u98 => u128);
arbitrary_int_impl!(u99 => u128);
arbitrary_int_impl!(u100 => u128);
arbitrary_int_impl!(u101 => u128);
arbitrary_int_impl!(u102 => u128);
arbitrary_int_impl!(u103 => u128);
arbitrary_int_impl!(u104 => u128);
arbitrary_int_impl!(u105 => u128);
arbitrary_int_impl!(u106 => u128);
arbitrary_int_impl!(u107 => u128);
arbitrary_int_impl!(u108 => u128);
arbitrary_int_impl!(u109 => u128);
arbitrary_int_impl!(u110 => u128);
arbitrary_int_impl!(u111 => u128);
arbitrary_int_impl!(u112 => u128);
arbitrary_int_impl!(u113 => u128);
arbitrary_int_impl!(u114 => u128);
arbitrary_int_impl!(u115 => u128);
arbitrary_int_impl!(u116 => u128);
arbitrary_int_impl!(u117 => u128);
arbitrary_int_impl!(u118 => u128);
arbitrary_int_impl!(u119 => u128);
arbitrary_int_impl!(u120 => u128);
arbitrary_int_impl!(u121 => u128);
arbitrary_int_impl!(u122 => u128);
arbitrary_int_impl!(u123 => u128);
arbitrary_int_impl!(u124 => u128);
arbitrary_int_impl!(u125 => u128);
arbitrary_int_impl!(u126 => u128);
arbitrary_int_impl!(u127 => u128);
3 changes: 3 additions & 0 deletions schemars/src/json_schema_impls/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ macro_rules! forward_impl {
};
}

#[cfg(feature = "arbitrary_int")]
mod arbitrary_int;

mod array;
#[cfg(feature = "arrayvec05")]
mod arrayvec05;
Expand Down
27 changes: 27 additions & 0 deletions schemars/tests/arbitrary_int.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
mod util;
use util::*;

#[test]
fn arbitrary_int_u1() -> TestResult {
test_default_generated_schema::<arbitrary_int::u1>("arbitrary_int_u1")
}
#[test]
fn arbitrary_int_u9() -> TestResult {
test_default_generated_schema::<arbitrary_int::u9>("arbitrary_int_u9")
}
#[test]
fn arbitrary_int_u17() -> TestResult {
test_default_generated_schema::<arbitrary_int::u17>("arbitrary_int_u17")
}
#[test]
fn arbitrary_int_u33() -> TestResult {
test_default_generated_schema::<arbitrary_int::u33>("arbitrary_int_u33")
}
#[test]
fn arbitrary_int_u65() -> TestResult {
test_default_generated_schema::<arbitrary_int::u65>("arbitrary_int_u65")
}
#[test]
fn arbitrary_int_u127() -> TestResult {
test_default_generated_schema::<arbitrary_int::u127>("arbitrary_int_u127")
}
8 changes: 8 additions & 0 deletions schemars/tests/expected/arbitrary_int_u1.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "u1",
"type": "integer",
"format": "uint8",
"maximum": 1.0,
"minimum": 0.0
}
8 changes: 8 additions & 0 deletions schemars/tests/expected/arbitrary_int_u127.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "u127",
"type": "integer",
"format": "uint128",
"maximum": 170141183460469231731687303715884105727.0,
"minimum": 0.0
}
8 changes: 8 additions & 0 deletions schemars/tests/expected/arbitrary_int_u17.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "u17",
"type": "integer",
"format": "uint32",
"maximum": 131071.0,
"minimum": 0.0
}
8 changes: 8 additions & 0 deletions schemars/tests/expected/arbitrary_int_u33.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "u33",
"type": "integer",
"format": "uint64",
"maximum": 8589934591.0,
"minimum": 0.0
}
8 changes: 8 additions & 0 deletions schemars/tests/expected/arbitrary_int_u65.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "u65",
"type": "integer",
"format": "uint128",
"maximum": 36893488147419103231.0,
"minimum": 0.0
}
8 changes: 8 additions & 0 deletions schemars/tests/expected/arbitrary_int_u9.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "u9",
"type": "integer",
"format": "uint16",
"maximum": 511.0,
"minimum": 0.0
}
Loading