-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement integer type to comply with spec (#98)
* feat: implement integer type to comply with spec The JSONPath spec states that integers, e.g., those used as indices or in slice selectors, must be within a specific range [-2^53 +1, 2^53 - 1]. This adds a new Integer type to be used to represent such integers, and check that they stay within that range. It also caught a couple of places where overflows would have led to panics.
- Loading branch information
Showing
11 changed files
with
269 additions
and
57 deletions.
There are no files selected for viewing
Submodule jsonpath-compliance-test-suite
updated
8 files
| +1,198 −117 | cts.json | |
| +10 −0 | tests/basic.json | |
| +283 −19 | tests/filter.json | |
| +42 −0 | tests/functions/match.json | |
| +30 −0 | tests/functions/search.json | |
| +48 −0 | tests/index_selector.json | |
| +155 −0 | tests/name_selector.json | |
| +156 −0 | tests/slice_selector.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| //! Representation of itegers in the JSONPath specification | ||
| //! | ||
| //! The JSONPath specification defines some rules for integers used in query strings (see [here][spec]). | ||
| //! | ||
| //! [spec]: https://www.rfc-editor.org/rfc/rfc9535.html#name-overview | ||
| use std::{ | ||
| num::{ParseIntError, TryFromIntError}, | ||
| str::FromStr, | ||
| }; | ||
|
|
||
| /// An integer for internet JSON ([RFC7493][ijson]) | ||
| /// | ||
| /// The value must be within the range [-(2<sup>53</sup>)+1, (2<sup>53</sup>)-1]). | ||
| /// | ||
| /// [ijson]: https://www.rfc-editor.org/rfc/rfc7493#section-2.2 | ||
| #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)] | ||
| pub struct Integer(i64); | ||
|
|
||
| /// The maximum allowed value, 2^53 - 1 | ||
| const MAX: i64 = 9_007_199_254_740_992 - 1; | ||
| /// The minimum allowed value (-2^53) + 1 | ||
| const MIN: i64 = -9_007_199_254_740_992 + 1; | ||
|
|
||
| impl Integer { | ||
| fn try_new(value: i64) -> Result<Self, IntegerError> { | ||
| if !(MIN..=MAX).contains(&value) { | ||
| Err(IntegerError::OutOfBounds) | ||
| } else { | ||
| Ok(Self(value)) | ||
| } | ||
| } | ||
|
|
||
| fn check(&self) -> bool { | ||
| (MIN..=MAX).contains(&self.0) | ||
| } | ||
|
|
||
| /// Produce an [`Integer`] with the value 0 | ||
| pub fn zero() -> Self { | ||
| Self(0) | ||
| } | ||
|
|
||
| /// Get an [`Integer`] from an `i64` | ||
| /// | ||
| /// This is intended for initializing an integer with small, non-zero numbers. | ||
| /// | ||
| /// # Panics | ||
| /// | ||
| /// This will panic if the inputted value is out of the valid range | ||
| /// [-(2<sup>53</sup>)+1, (2<sup>53</sup>)-1]). | ||
| pub fn from_i64_unchecked(value: i64) -> Self { | ||
| Self::try_new(value).expect("value is out of the valid range") | ||
| } | ||
|
|
||
| /// Take the absolute value, producing `None` if the resulting value is outside | ||
| /// the valid range [-(2<sup>53</sup>)+1, (2<sup>53</sup>)-1]). | ||
| pub fn checked_abs(mut self) -> Option<Self> { | ||
| self.0 = self.0.checked_abs()?; | ||
| self.check().then_some(self) | ||
| } | ||
|
|
||
| /// Add the two values, producing `None` if the resulting value is outside the | ||
| /// valid range [-(2<sup>53</sup>)+1, (2<sup>53</sup>)-1]). | ||
| pub fn checked_add(mut self, rhs: Self) -> Option<Self> { | ||
| self.0 = self.0.checked_add(rhs.0)?; | ||
| self.check().then_some(self) | ||
| } | ||
|
|
||
| /// Subtract the `rhs` from `self`, producing `None` if the resulting value is | ||
| /// outside the valid range [-(2<sup>53</sup>)+1, (2<sup>53</sup>)-1]). | ||
| pub fn checked_sub(mut self, rhs: Self) -> Option<Self> { | ||
| self.0 = self.0.checked_sub(rhs.0)?; | ||
| self.check().then_some(self) | ||
| } | ||
|
|
||
| /// Multiply the two values, producing `None` if the resulting value is outside | ||
| /// the valid range [-(2<sup>53</sup>)+1, (2<sup>53</sup>)-1]). | ||
| pub fn checked_mul(mut self, rhs: Self) -> Option<Self> { | ||
| self.0 = self.0.checked_mul(rhs.0)?; | ||
| self.check().then_some(self) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<i64> for Integer { | ||
| type Error = IntegerError; | ||
|
|
||
| fn try_from(value: i64) -> Result<Self, Self::Error> { | ||
| Self::try_new(value) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<usize> for Integer { | ||
| type Error = IntegerError; | ||
|
|
||
| fn try_from(value: usize) -> Result<Self, Self::Error> { | ||
| i64::try_from(value) | ||
| .map_err(|_| IntegerError::OutOfBounds) | ||
| .and_then(Self::try_new) | ||
| } | ||
| } | ||
|
|
||
| impl FromStr for Integer { | ||
| type Err = IntegerError; | ||
|
|
||
| fn from_str(s: &str) -> Result<Self, Self::Err> { | ||
| s.parse::<i64>().map_err(Into::into).and_then(Self::try_new) | ||
| } | ||
| } | ||
|
|
||
| impl std::fmt::Display for Integer { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| write!(f, "{}", self.0) | ||
| } | ||
| } | ||
|
|
||
| impl TryFrom<Integer> for usize { | ||
| type Error = TryFromIntError; | ||
|
|
||
| fn try_from(value: Integer) -> Result<Self, Self::Error> { | ||
| Self::try_from(value.0) | ||
| } | ||
| } | ||
|
|
||
| impl PartialEq<i64> for Integer { | ||
| fn eq(&self, other: &i64) -> bool { | ||
| self.0.eq(other) | ||
| } | ||
| } | ||
|
|
||
| impl PartialOrd<i64> for Integer { | ||
| fn partial_cmp(&self, other: &i64) -> Option<std::cmp::Ordering> { | ||
| self.0.partial_cmp(other) | ||
| } | ||
| } | ||
|
|
||
| /// An error for the [`Integer`] type | ||
| #[derive(Debug, thiserror::Error)] | ||
| pub enum IntegerError { | ||
| /// The provided value was outside the valid range [-(2**53)+1, (2**53)-1]) | ||
| #[error("the provided integer was outside the valid range, see https://www.rfc-editor.org/rfc/rfc9535.html#section-2.1-4.1")] | ||
| OutOfBounds, | ||
| /// Integer parsing error | ||
| #[error(transparent)] | ||
| Parse(#[from] ParseIntError), | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| //! Types representing the IETF JSONPath Standard | ||
| pub mod functions; | ||
| pub mod integer; | ||
| pub mod query; | ||
| pub mod segment; | ||
| pub mod selector; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.