Struct rsonpath::query::NonNegativeArrayIndex

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

Array index to search for in a JSON document.

Represents a specific location from the front of the list in a json array. Provides the IETF-conforming index value. Values are [0, (2^53)-1].

Examples

let idx = NonNegativeArrayIndex::new(2);

assert_eq!(idx.get_index(), 2);

Implementations

impl NonNegativeArrayIndex

pub const ZERO: Self = _

A constant index for the common and starting case of the first item.

pub const MAX: Self = _

A constant index for the largest addressable index.

pub const fn new(index: u64) -> Self

Create a new search index from a u64.

pub fn try_increment(&mut self) -> Result<(), ArrayIndexError>

Create a new search index from a u64.

Errors

Will return Err if the increment causes the NonNegativeArrayIndex to exceed the addressable IETF-conforming index value value.

pub const fn get_index(&self) -> u64

Return the index stored.

Trait Implementations

impl Clone for NonNegativeArrayIndex

fn clone(&self) -> NonNegativeArrayIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NonNegativeArrayIndex

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

Formats the value using the given formatter.

impl Display for NonNegativeArrayIndex

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

Formats the value using the given formatter.

impl From<NonNegativeArrayIndex> for u64

fn from(val: NonNegativeArrayIndex) -> Self

Converts to this type from the input type.

impl Ord for NonNegativeArrayIndex

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<NonNegativeArrayIndex> for NonNegativeArrayIndex

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd<NonNegativeArrayIndex> for NonNegativeArrayIndex

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl TryFrom<u64> for NonNegativeArrayIndex

type Error = ArrayIndexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for NonNegativeArrayIndex

impl Eq for NonNegativeArrayIndex

impl StructuralEq for NonNegativeArrayIndex

impl StructuralPartialEq for NonNegativeArrayIndex