Struct Area 

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

An Area is a box in three-dimensional willow space, consisting of all entries matching either a single subspace id or entries of arbitrary subspace ids, prefixed by some Path, and a TimeRange.

Areas are the default way by which application developers should aggregate entries. See the specification for more details.

use willow_data_model::prelude::*;

let a1 = Area::<2, 2, 2, u8>::new(None, Path::new(), TimeRange::new_closed(0.into(), 17.into()));

assert!(a1.wdm_includes(&(6, Path::new(), Timestamp::from(9))));
assert_eq!(a1.subspace(), None);

let a2 = Area::<2, 2, 2, u8>::new(Some(42), Path::new(), TimeRange::new_open(15.into()));
assert_eq!(
    a1.wdm_intersection(&a2),
    Ok(Area::<2, 2, 2, u8>::new(
        Some(42),
        Path::new(),
        TimeRange::new_closed(15.into(), 17.into()),
    )),
);

Specification

Implementations

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

pub fn new( subspace: Option<S>, path: Path<MCL, MCC, MPL>, times: TimeRange, ) -> Self

Creates a new Area from its constituent optional subspace id, Path, and TimeRange.

use willow_data_model::prelude::*;

let a = Area::<2, 2, 2, u8>::new(None, Path::new(), TimeRange::new_closed(0.into(), 17.into()));

assert!(a.wdm_includes(&(6, Path::new(), Timestamp::from(9))));
assert_eq!(a.subspace(), None);

pub fn subspace(&self) -> Option<&S>

Returns a reference to the inner subspace id, if any.

use willow_data_model::prelude::*;

let a1 = Area::<2, 2, 2, u8>::new(Some(17), Path::new(), TimeRange::new_closed(0.into(), 17.into()));
assert_eq!(a1.subspace(), Some(&17));

let a2 = Area::<2, 2, 2, u8>::new(None, Path::new(), TimeRange::new_closed(0.into(), 17.into()));
assert_eq!(a2.subspace(), None);

Definition.

pub fn path(&self) -> &Path<MCL, MCC, MPL>

Returns a reference to the inner Path.

use willow_data_model::prelude::*;

let a = Area::<2, 2, 2, u8>::new(Some(17), Path::new(), TimeRange::new_closed(0.into(), 17.into()));
assert_eq!(a.path(), &Path::new());

Definition.

pub fn times(&self) -> &TimeRange

Returns a reference to the inner TimeRange.

use willow_data_model::prelude::*;

let a = Area::<2, 2, 2, u8>::new(Some(17), Path::new(), TimeRange::new_closed(0.into(), 17.into()));
assert_eq!(a.times(), &WillowRange::from(TimeRange::new_closed(0.into(), 17.into())));

Definition.

pub fn set_subspace(&mut self, new_subspace: Option<S>)

Sets the inner subspace id.

pub fn set_path(&mut self, new_path: Path<MCL, MCC, MPL>)

Sets the inner Path.

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

where TR: Into<TimeRange>,

Sets the inner TimeRange.

pub fn new_subspace_area(subspace_id: S) -> Self

Returns the subspace area for the given subspace id, i.e., the area which includes exactly the entries of the given subspace id.

use willow_data_model::prelude::*;

let a = Area::<2, 2, 2, u8>::new_subspace_area(17);

assert!(a.wdm_includes(&(17, Path::new(), Timestamp::from(9))));
assert!(!a.wdm_includes(&(18, Path::new(), Timestamp::from(9))));
assert_eq!(a.subspace(), Some(&17));

pub fn as_ref_subspace(&self) -> Area<MCL, MCC, MPL, &S>

Turns an &Area<MCL, MCC, MPL, S> into an Area<MCL, MCC, MPL, &S>.

Works by using Option::as_ref on the subspace and cloning everything else.

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

where S: PartialEq,

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

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

Returns whether an Entry of the given coordinate could possibly cause prefix pruning in this area.

use willow_data_model::prelude::*;

let a = Area::<2, 2, 2, u8>::new(Some(17), Path::new(), TimeRange::new_closed(0.into(), 17.into()));

assert!(a.admits_pruning_by(&(17, Path::new(), Timestamp::from(9))));
assert!(!a.admits_pruning_by(&(18, Path::new(), Timestamp::from(9))));

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

pub fn full() -> Self

Returns the Area which includes every coordinate.

use willow_data_model::prelude::*;

let a = Area::<2, 2, 2, u8>::full();

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

pub fn is_full(&self) -> bool

Returns whether self is the full area, i.e., the area which includes every coordinate.

use willow_data_model::prelude::*;

assert!(Area::<2, 2, 2, u8>::full().is_full());
assert!(!Area::<2, 2, 2, u8>::new(Some(17), Path::new(), TimeRange::new_closed(0.into(), 17.into())).is_full());

Trait Implementations

impl<'arbitrary, const MCL: usize, const MCC: usize, const MPL: usize, S: Arbitrary<'arbitrary>> Arbitrary<'arbitrary> for Area<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 Area<MCL, MCC, MPL, S>

fn clone(&self) -> Area<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 Area<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 Area<MCL, MCC, MPL, S>

where S: PartialOrd,

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 Area<MCL, MCC, MPL, S>

where S: PartialEq,

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 Area<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 Area<MCL, MCC, MPL, S>

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

where S: PartialEq,

An area is less than another iff all values included in the first are also included in the other.

This implementation assumes that S is inhabited by more than one value.

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

An area is less than another iff all values included in the first are also included in the other.

This implementation assumes that S is inhabited by more than one value.

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> RelativeDecodable<Area<MCL, MCC, MPL, S>> for Area<MCL, MCC, MPL, S>

where S: DecodableCanonic<ErrorReason: Into<Blame>, ErrorCanonic: Into<Blame>> + Clone + PartialEq,

Implements EncodeAreaInArea.

type ErrorReason = Blame

Reason why decoding can fail (beyond an unexpected end of input or a producer error).

async fn relative_decode<P>( rel: &Area<MCL, MCC, MPL, S>, producer: &mut P, ) -> Result<Self, DecodeError<P::Final, P::Error, Blame>>

where P: BulkProducer<Item = u8> + ?Sized,

Decodes the symbols produced by the given bulk producer relative to rel into a Self, or yields an error if the producer does not produce a valid relative encoding.

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

where S: DecodableCanonic<ErrorReason: Into<Blame>, ErrorCanonic: Into<Blame>> + Clone + PartialEq,

Implements encode_area_in_area.

type ErrorCanonic = Blame

The type for reporting that the sequence of symbols to decode was not a valid canonic encoding of any value of type Self.

async fn relative_decode_canonic<P>( rel: &Area<MCL, MCC, MPL, S>, producer: &mut P, ) -> Result<Self, DecodeError<P::Final, P::Error, Blame>>

where P: BulkProducer<Item = u8> + ?Sized, Self: Sized,

Decodes the symbols produced by the given bulk producer relative to rel into a Self, and errors if the input encoding is not the canonical one.

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

where S: PartialEq + Encodable,

Implements encode_area_in_area.

fn can_be_encoded_relative_to(&self, rel: &Area<MCL, MCC, MPL, S>) -> bool

Returns true iff rel includes self.

async fn relative_encode<C>( &self, rel: &Area<MCL, MCC, MPL, S>, consumer: &mut C, ) -> Result<(), C::Error>

where C: BulkConsumer<Item = u8> + ?Sized,

Writes an encoding of &self relative to rel into the given bulk consumer.

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

where S: PartialEq + EncodableKnownLength,

Implements encode_area_in_area.

fn len_of_relative_encoding(&self, rel: &Area<MCL, MCC, MPL, S>) -> usize

Computes the number of symbols of the encoding of self, relative to rel. A successful call to relative_encode must feed exactly that many symbols into the bulk consumer.

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

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