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::<4, 4, 4, TestSubspace>::new(
    SubspaceRange::new_open(Betty),
    PathRange::full(),
    TimeRange::new_closed(0.into(), 17.into())
);

assert!(r.wdm_includes(&(Gemma, Path::new(), Timestamp::from(9))));
assert_eq!(r.subspaces(), &SubspaceRange::new_open(Betty));

let r2 = Range3d::<4, 4, 4, TestSubspace>::new(
    SubspaceRange::new_closed(Alfie, Dalton),
    PathRange::full(),
    TimeRange::new_open(15.into()),
);
assert_eq!(
    r.wdm_intersection(&r2),
    Ok(Range3d::<4, 4, 4, TestSubspace>::new(
        SubspaceRange::new_closed(Betty, Dalton),
        PathRange::full(),
        TimeRange::new_closed(15.into(), 17.into()),
    )),
);

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::<4, 4, 4, TestSubspace>::new(
    SubspaceRange::new_open(Betty),
    PathRange::full(),
    TimeRange::new_closed(0.into(), 17.into())
);

assert!(r.wdm_includes(&(Gemma, Path::new(), Timestamp::from(9))));
assert_eq!(r.subspaces(), &SubspaceRange::new_open(Betty));

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

Returns a reference to the inner SubspaceRange.

use willow_data_model::prelude::*;

let r = Range3d::<4, 4, 4, TestSubspace>::new(
    SubspaceRange::new_open(Betty),
    PathRange::full(),
    TimeRange::new_closed(0.into(), 17.into())
);
assert_eq!(r.subspaces(), &SubspaceRange::new_open(Betty));

Definition.

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

Returns a reference to the inner PathRange.

use willow_data_model::prelude::*;
let r = Range3d::<4, 4, 4, TestSubspace>::new(
    SubspaceRange::new_open(Betty),
    PathRange::full(),
    TimeRange::new_closed(0.into(), 17.into())
);
assert_eq!(r.paths(), &PathRange::full());

Definition.

pub fn times(&self) -> &TimeRange

Returns a reference to the inner TimeRange.

use willow_data_model::prelude::*;

let r = Range3d::<4, 4, 4, TestSubspace>::new(
    SubspaceRange::new_open(Betty),
    PathRange::full(),
    TimeRange::new_closed(0.into(), 17.into())
);
assert_eq!(r.times(), &TimeRange::new_closed(0.into(), 17.into()));

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::<4, 4, 4, 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: LeastElement,

pub fn full() -> Self

Returns the Range3d which includes every coordinate.

use willow_data_model::prelude::*;

let r = Range3d::<4, 4, 4, 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::<4, 4, 4, TestSubspace>::full().is_full());
assert!(!Range3d::<4, 4, 4, TestSubspace>::new(
    SubspaceRange::new_open(Betty),
    PathRange::full(),
    TimeRange::new_closed(0.into(), 17.into()),
).is_full());

Trait Implementations

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

where S: PartialOrd + Arbitrary<'a>,

Available on crate feature dev only.

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

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

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.

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.

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: LeastElement,

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: PartialOrd,

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_intersection(&self, other: &Self) -> Result<Self, EmptyGrouping>

where S: Clone,

Returns a grouping which includes exactly those values included by both self and other. If that set would be empty, returns an EmptyGrouping error instead.

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 both self and other.

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

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

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

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

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