Struct Range3d 

pub struct Range3d<const MCL: usize, const MCC: usize, const MPL: usize, S> { /* private fields */ }

An arbitrary box in three-dimensional willow space, consisting of a SubspaceRange, a PathRange, and a TimeRange.

As an application developer, you probably do not need to interact with 3d ranges, you should prefer Areas — the latter work well with encrypted data, whereas 3d ranges do not define human-meaningful subsets of data when working with encryption.

use willow_data_model::prelude::*;

let r = Range3d::<2, 2, 2, u8>::new(5..=8, .., ..Timestamp::from(17));

assert!(r.wdm_includes(&(6, Path::new(), Timestamp::from(9))));
assert_eq!(r.subspaces(), &WillowRange::from(5u8..9));

let r2 = Range3d::<2, 2, 2, u8>::new(7..8, .., Timestamp::from(15)..);
assert_eq!(
    r.wdm_intersection(&r2),
    Range3d::<2, 2, 2, u8>::new(7..8, .., Timestamp::from(15)..Timestamp::from(17)),
);

Specification

Implementations

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> Range3d<MCL, MCC, MPL, S>

pub fn new<SR, PR, TR>(subspaces: SR, paths: PR, times: TR) -> Self

where SR: Into<SubspaceRange<S>>, PR: Into<PathRange<MCL, MCC, MPL>>, TR: Into<TimeRange>,

Creates a new Range3d from its constituent SubspaceRange, PathRange, and TimeRange.

use willow_data_model::prelude::*;

let r = Range3d::<2, 2, 2, u8>::new(5..=8, .., ..Timestamp::from(17));

assert!(r.wdm_includes(&(6, Path::new(), Timestamp::from(9))));
assert_eq!(r.subspaces(), &WillowRange::from(5u8..9));

pub fn subspaces(&self) -> &SubspaceRange<S>

Returns a reference to the inner SubspaceRange.

use willow_data_model::prelude::*;

let r = Range3d::<2, 2, 2, u8>::new(5..=8, .., ..Timestamp::from(17));
assert_eq!(r.subspaces(), &SubspaceRange::from(5u8..9));

Definition.

pub fn paths(&self) -> &PathRange<MCL, MCC, MPL>

Returns a reference to the inner PathRange.

use willow_data_model::prelude::*;

let r = Range3d::<2, 2, 2, u8>::new(5..=8, .., ..Timestamp::from(17));
assert_eq!(r.paths(), &WillowRange::full());

Definition.

pub fn times(&self) -> &TimeRange

Returns a reference to the inner TimeRange.

use willow_data_model::prelude::*;

let r = Range3d::<2, 2, 2, u8>::new(5..=8, .., ..Timestamp::from(17));
assert_eq!(r.times(), &WillowRange::from(..Timestamp::from(17)));

Definition.

pub fn set_subspaces<SR>(&mut self, new_range: SR)

where SR: Into<SubspaceRange<S>>,

Sets the inner SubspaceRange.

pub fn set_paths<PR>(&mut self, new_range: PR)

where PR: Into<PathRange<MCL, MCC, MPL>>,

Sets the inner PathRange.

pub fn set_times<TR>(&mut self, new_range: TR)

where TR: Into<TimeRange>,

Sets the inner TimeRange.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> Range3d<MCL, MCC, MPL, S>

where S: Clone + SuccessorExceptForGreatest,

pub fn singleton<Coord>(coord: &Coord) -> Self

where Coord: Coordinatelike<MCL, MCC, MPL, S>,

Returns the Range3d which includes coord but no other value.

use willow_data_model::prelude::*;

let r = Range3d::<2, 2, 2, u8>::singleton(&(6, Path::new(), Timestamp::from(9)));

assert!(r.wdm_includes(&(6, Path::new(), Timestamp::from(9))));
assert!(!r.wdm_includes(&(16, Path::new(), Timestamp::from(9))));

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

pub fn full() -> Self

Returns the Range3d which includes every coordinate.

use willow_data_model::prelude::*;

let r = Range3d::<2, 2, 2, u8>::full();

assert!(r.wdm_includes(&(6, Path::new(), Timestamp::from(9))));
assert!(r.wdm_includes(&(16, Path::new(), Timestamp::from(9))));

pub fn is_full(&self) -> bool

Returns whether self is the full 3d range, i.e., the 3d range which includes every coordinate.

use willow_data_model::prelude::*;

assert!(Range3d::<2, 2, 2, u8>::full().is_full());
assert!(!Range3d::<2, 2, 2, u8>::new(5..=8, .., ..Timestamp::from(17)).is_full());

Trait Implementations

impl<'arbitrary, const MCL: usize, const MCC: usize, const MPL: usize, S: Arbitrary<'arbitrary>> Arbitrary<'arbitrary> for Range3d<MCL, MCC, MPL, S>

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

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

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

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<const MCL: usize, const MCC: usize, const MPL: usize, S: Clone> Clone for Range3d<MCL, MCC, MPL, S>

fn clone(&self) -> Range3d<MCL, MCC, MPL, S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S: Debug> Debug for Range3d<MCL, MCC, MPL, S>

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

Formats the value using the given formatter.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> From<Area<MCL, MCC, MPL, S>> for Range3d<MCL, MCC, MPL, S>

where S: Clone + SuccessorExceptForGreatest + LeastElement,

fn from(value: Area<MCL, MCC, MPL, S>) -> Self

Converts to this type from the input type.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> GreatestElement for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

fn greatest() -> Self

Returns the unique greatest element.

fn is_greatest(&self) -> bool

Returns true if and only if self is the greatest element.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> Grouping<MCL, MCC, MPL, S> for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

fn wdm_includes<Coord>(&self, coord: &Coord) -> bool

where Coord: Coordinatelike<MCL, MCC, MPL, S> + ?Sized,

Returns true iff the given Coordinatelike value is included in this grouping.

fn wdm_includes_grouping(&self, other: &Self) -> bool

Returns true iff every value included in other is also included in self.

fn wdm_strictly_includes_grouping(&self, other: &Self) -> bool

Returns true iff every value included in other is also included in self and self and other are not equal.

fn wdm_includes_in_intersection<Coord>( &self, other: &Self, coord: &Coord, ) -> bool

where Coord: Coordinatelike<MCL, MCC, MPL, S> + ?Sized,

Returns true iff the given Coordinatelike value is included in the intersection of self and other.

fn wdm_is_empty(&self) -> bool

Returns true iff self includes no values.

fn wdm_empty() -> Self

Returns a grouping which includes no values.

fn wdm_intersection(&self, other: &Self) -> Self

Returns a grouping which includes exactly those values included by both self and other.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> Hash for Range3d<MCL, MCC, MPL, S>

where S: Hash + Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

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<const MCL: usize, const MCC: usize, const MPL: usize, S> LeastElement for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

fn least() -> Self

Returns the unique least element.

fn is_least(&self) -> bool

Returns true if and only if self is the least element.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> LowerSemilattice for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

fn greatest_lower_bound(&self, other: &Self) -> Self

Returns the greatest lower bound of self and other, i.e., the unique greatest element in the type which is less than or equal to both self and other.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> PartialEq for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

A 3d-range is equal to another iff both include exactly the same values.

fn eq(&self, other: &Self) -> 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<const MCL: usize, const MCC: usize, const MPL: usize, S> PartialOrd for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

A 3d-range is less than another iff all values included in the first are also included in the other.

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

A 3d-range is less than another iff all values included in the first are also included in the other.

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<const MCL: usize, const MCC: usize, const MPL: usize, S> UpperSemilattice for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,

fn least_upper_bound(&self, other: &Self) -> Self

Returns the least upper bound of self and other, i.e., the unique least element in the type which is greater than or equal to both self and other.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S> Eq for Range3d<MCL, MCC, MPL, S>

where S: Clone + Ord + PredecessorExceptForLeast + SuccessorExceptForGreatest,