Skip to content

Commit a537ecd

Browse files
maciejhirszmaciejhirsz
committed
Fixed tests, redacted README, added Apache 2.0 license as an option.
1 parent fc51639 commit a537ecd

File tree

6 files changed

+243
-44
lines changed

6 files changed

+243
-44
lines changed

‎Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ authors = ["Maciej Hirsz <[email protected]>"]
55
description = "JSON implementation in Rust"
66
repository = "https://github.com/maciejhirsz/json-rust"
77
documentation = "http://terhix.com/doc/json/"
8-
license = "MIT"
8+
license = "MIT/Apache-2.0"
99

1010
[dependencies]
1111
itoa = "0.1"

‎LICENSE-APACHE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2016 Maciej Hirsz <[email protected]>
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎LICENSE renamed to ‎LICENSE-MIT

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Copyright (c) 2016 Maciej Hirsz <[email protected]>
22

3-
he MIT License (MIT)
3+
The MIT License (MIT)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,12 +110,26 @@ Then import it in your `main.rs` / `lib.rs` file:
110110
extern crate json;
111111
```
112112

113-
## Performance
113+
## Performance and Conformance
114114

115-
There used to be a statement here saying that performance is not the main goal of this crate. It is definitely one of them now.
115+
There used to be a statement here saying that performance is not the main goal of this
116+
crate. It is definitely one of them now.
116117

117-
![](http://terhix.com/json-perf-10.png)
118+
While this crate doesn't provide a way to parse JSON to native Rust structs, it does a
119+
lot to optimize it's performance for DOM parsing, stringifying and manipulation. It does
120+
[very well in benchmarks](https://github.com/serde-rs/json-benchmark), in some cases it
121+
can even outperform parsing to structs.
118122

119-
[The benchmarks](https://github.com/maciejhirsz/json-rust/blob/benches/benches/log.rs) were run on 2012 MacBook Air, your results may vary. Many thanks to [@dtolnay](https://github.com/dtolnay) for providing the baseline struct and test data the tests could be run on.
123+
This crate implements the standard according to the [
124+
RFC 7159](https://tools.ietf.org/html/rfc7159) and
125+
[ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf)
126+
documents. It makes some compromises when it comes to number precision, but they are
127+
both within the specification and advised practices for best interoperability,
128+
specifically those discussed in the RFC.
120129

121-
While this is not necessarily a be-all end-all benchmark, the main takeaway from this is that Serde parsing is much faster when parsing to a struct, since the parser knows exactly the kind of data it needs, and doesn't pay the (re)allocation costs of pushing data to a map. Also worth noting, rustc-serialize suffers since it first has to parse JSON to generic enum-based values, and only then map those onto structs.
130+
## License
131+
132+
This crate is distributed under the terms of both the MIT license
133+
and the Apache License (Version 2.0), choose whatever works for you.
134+
135+
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) for details.

‎src/object.rs

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ const KEY_BUF_LEN: usize = 30;
66

77
struct Node {
88
// Internal buffer to store keys that fit within `KEY_BUF_LEN`,
9-
// otherwise this field can contain garbage.
9+
// otherwise this field will contain garbage.
1010
pub key_buf: [u8; KEY_BUF_LEN],
1111

1212
// Length of the key in bytes.
@@ -23,12 +23,12 @@ struct Node {
2323
// Value stored.
2424
pub value: JsonValue,
2525

26-
// Store index within the object where one can find a node where hash
27-
// is smaller than the hash of this node.
26+
// Store vector index pointing to the `Node` for which `key_hash` is smaller
27+
// than that of this `Node`.
2828
// Will default to 0 as root node can't be referrenced anywhere else.
2929
pub left: usize,
3030

31-
// Same as above but for nodes with hash larger than this one. If the
31+
// Same as above but for `Node`s with hash larger than this one. If the
3232
// hash is the same, but keys are different, the lookup will default
3333
// to the right branch as well.
3434
pub right: usize,
@@ -48,20 +48,21 @@ impl PartialEq for Node {
4848
}
4949
}
5050

51-
// Because `Node` contains a raw pointer, `Sync` is not marked on it. This
51+
// Because `Node` contains a raw pointer, `Sync` marker is missing. This
5252
// in turn disables `Sync` for `Object`, and eventually `JsonValue`. Without
5353
// the `Sync` marker it's impossible to create a static `JsonValue`, which
54-
// would break all the API that returns `&'static JsonValue::Null`. Since
55-
// `Node` is not exposed anywhere in the API on it's own, and we manage heap
56-
// of long keys manually, we just need to tell the compiler we know what we
57-
// are doing here.
54+
// would break all the API that returns `&'static JsonValue::Null`.
55+
//
56+
// Since `Node` is not exposed anywhere in the API on it's own, and we manage
57+
// heap of long keys manually, we just need to tell the compiler we know what
58+
// we are doing here.
5859
unsafe impl Sync for Node { }
5960

60-
// Simple FNV 1a implementation
61+
// FNV-1a implementation
6162
//
6263
// While the `Object` is implemented as a binary tree, not a hash table, the
6364
// order in which the tree is balanced makes absolutely no difference as long
64-
// as there is a deterministic left / right ordering of the hashed value.
65+
// as there is a deterministic left / right ordering with good spread.
6566
// Comparing a hashed `u64` is faster than comparing `&str` or even `&[u8]`,
6667
// for larger objects this yields non-trivial performance benefits.
6768
//
@@ -70,7 +71,6 @@ unsafe impl Sync for Node { }
7071
// using an object as a store for entires by ids, where ids are sorted), this
7172
// will prevent the tree from being constructed in a way where the same branch
7273
// of each node is always used, effectively producing linear lookup times. Bad!
73-
// Using this solution fixes that problem.
7474
//
7575
// Example:
7676
//
@@ -130,8 +130,9 @@ impl Node {
130130
}
131131

132132
// While `new` crates a fresh `Node` instance, it cannot do much about
133-
// the `key_*` fields. Only once the `Node` somewhere on the heap, we
134-
// can determine `key_ptr` that is not going to change.
133+
// the `key_*` fields. In case of short keys that can be stored on the
134+
// `Node`, only once the `Node` is somewhere on the heap, a persisting
135+
// pointer to the key can be obtained.
135136
#[inline(always)]
136137
fn attach_key(&mut self, key: &[u8], hash: u64) {
137138
self.key_len = key.len();
@@ -153,8 +154,8 @@ impl Node {
153154
}
154155

155156
// Since `Node`s are stored on a `Vec<Node>`, they will suffer from
156-
// reallocation changing `key_ptr` addresses for buffered keys. This
157-
// needs to be called on each `Node` after each reallocation to fix that.
157+
// reallocation, changing `key_ptr` addresses for buffered keys. This
158+
// needs to be called on each `Node` after each reallocation.
158159
#[inline(always)]
159160
fn fix_key_ptr(&mut self) {
160161
if self.key_len <= KEY_BUF_LEN {
@@ -163,8 +164,7 @@ impl Node {
163164
}
164165
}
165166

166-
// Because long keys _can_ be stored separately from the `Node` on heap, but are
167-
// not stored directly on the `Node` in any form aside from the raw pointer,
167+
// Because long keys _can_ be stored separately from the `Node` on heap,
168168
// it's essential to clean up the heap allocation when the `Node` is dropped.
169169
impl Drop for Node {
170170
fn drop(&mut self) {
@@ -178,17 +178,15 @@ impl Drop for Node {
178178
self.key_len
179179
);
180180

181-
// Now that we have an owned `Vec`, dropping it will deallocate it.
182-
drop(heap);
181+
// Now that we have an owned `Vec<u8>`, it will get deallocated at
182+
// the end of the block.
183183
}
184184
}
185185
}
186186
}
187187

188188
// Just like with `Drop`, `Clone` needs a custom implementation that accounts
189-
// for the fact that key _can_ be heap allcated, thefore any cloning needs to
190-
// check what type of a key is being held on the node, and if it is heap allocated
191-
// it needs to make a clone of it.
189+
// for the fact that key _can_ be separately heap allcated.
192190
impl Clone for Node {
193191
fn clone(&self) -> Self {
194192
unsafe {

‎tests/lib.rs

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -992,20 +992,6 @@ mod unit {
992992

993993
assert_eq!(String::from_utf8(buf).unwrap(), r#"{"foo":["bar",100,true]}"#);
994994
}
995-
996-
#[test]
997-
fn into_iter() {
998-
let mut iter = array!["foo", true, 42].into_iter();
999-
assert_eq!(iter.next(), Some("foo".into()));
1000-
assert_eq!(iter.next(), Some(true.into()));
1001-
assert_eq!(iter.next(), Some(42.into()));
1002-
1003-
let mut empty_iter = object!{"foo" => "bar"}.into_iter();
1004-
assert_eq!(empty_iter.next(), None);
1005-
1006-
let mut empty_iter = JsonValue::Null.into_iter();
1007-
assert_eq!(empty_iter.next(), None);
1008-
}
1009995
}
1010996

1011997
mod json_checker_fail {

0 commit comments

Comments
 (0)