Struct JsonNonZeroUInt

pub struct JsonNonZeroUInt(/* private fields */);

Unsigned interoperable JSON integer known to be non-zero.

Provides an IETF-conforming integer value guaranteed to be positive. Values are (0, (2⁵³)-1].

All values in a JSONPath query are limited to the [-2⁵³+1, (2⁵³)-1] range for interoperability (see RFC 2.1-4.1). Some, like array indices, are additionally restricted to the non-negative part, while indexing from the end of an array requires a positive value.

The zero-compatible version is JsonUInt.

Examples

let two = JsonNonZeroUInt::try_from(2).expect("within range");
assert_eq!(two.as_u64(), 2);

let zero = JsonNonZeroUInt::try_from(0).expect_err("out of range");
let too_big = JsonNonZeroUInt::try_from(1_u64 << 53).expect_err("out of range");

Implementations

impl JsonNonZeroUInt

pub const fn as_non_zero_u64(&self) -> NonZeroU64

Return the value stored as a NonZeroU64.

Examples

let val = JsonNonZeroUInt::try_from(42).unwrap();
assert_eq!(val.as_non_zero_u64(), NonZeroU64::new(42).unwrap());

pub const fn as_u64(&self) -> u64

Return the value stored as a u64.

Examples

let val = JsonNonZeroUInt::try_from(42).unwrap();
assert_eq!(val.as_u64(), 42);

Trait Implementations

impl<'a> Arbitrary<'a> for JsonNonZeroUInt

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for JsonNonZeroUInt

fn clone(&self) -> JsonNonZeroUInt

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JsonNonZeroUInt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsonNonZeroUInt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JsonNonZeroUInt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<JsonNonZeroUInt> for JsonUInt

fn from(value: JsonNonZeroUInt) -> Self

Converts to this type from the input type.

impl From<NonZero<u32>> for JsonNonZeroUInt

fn from(value: NonZeroU32) -> Self

Converts to this type from the input type.

impl From<NonZero<u64>> for JsonNonZeroUInt

fn from(value: NonZeroU64) -> Self

Converts to this type from the input type.

impl FromStr for JsonNonZeroUInt

type Err = JsonIntParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for JsonNonZeroUInt

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for JsonNonZeroUInt

fn cmp(&self, other: &JsonNonZeroUInt) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for JsonNonZeroUInt

fn eq(&self, other: &JsonNonZeroUInt) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for JsonNonZeroUInt

fn partial_cmp(&self, other: &JsonNonZeroUInt) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for JsonNonZeroUInt

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<JsonUInt> for JsonNonZeroUInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

fn try_from(value: JsonUInt) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i32> for JsonNonZeroUInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<i64> for JsonNonZeroUInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u32> for JsonNonZeroUInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for JsonNonZeroUInt

type Error = JsonIntOverflowError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for JsonNonZeroUInt

impl Eq for JsonNonZeroUInt

impl StructuralPartialEq for JsonNonZeroUInt