Struct Area

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

A grouping of entries.

Definition.

Implementations

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

pub fn new( subspace: AreaSubspace<S>, path: Path<MCL, MCC, MPL>, times: Range<Timestamp>, ) -> Self

Creates a new Area.

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

Returns a reference to the AreaSubspace.

To be included in this Area, an Entry’s subspace_id must be equal to the subspace_id, unless it is any.

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

Returns a reference to the Path.

To be included in this Area, an Entry’s path must be prefixed by the path.

pub fn times(&self) -> &Range<Timestamp>

Returns a reference to the range of Timestamps.

To be included in this Area, an Entry’s timestamp must be included in the times.

pub fn new_full() -> Self

Returns an Area which includes all entries.

Definition.

pub fn new_subspace(sub: S) -> Self

Returns an Area which includes all entries within a given subspace.

Definition.

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

where S: PartialEq,

pub fn includes_entry<N, PD>( &self, entry: &Entry<MCL, MCC, MPL, N, S, PD>, ) -> bool

Returns whether an Area includes an Entry.

pub fn includes_triplet( &self, subspace_id: &S, path: &Path<MCL, MCC, MPL>, timestamp: Timestamp, ) -> bool

Returns whether an Area includes includes an entry with a given subspace_id, path, and timestamp.

pub fn includes_area(&self, area: &Self) -> bool

Returns whether an Area fully includes another Area.

pub fn could_be_pruned_by<N, PD>( &self, entry: &Entry<MCL, MCC, MPL, N, S, PD>, ) -> bool

Returns whether an Entry can cause prefix-pruning in this Area.

pub fn could_be_pruned_by_triplet( &self, subspace_id: &S, path: &Path<MCL, MCC, MPL>, timestamp: Timestamp, ) -> bool

Returns whether an Entry of the given subspace_id, path, and timestamp can cause prefix-pruning in this Area.

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

where S: PartialEq + Clone,

pub fn intersection(&self, other: &Area<MCL, MCC, MPL, S>) -> Option<Self>

Returns the intersection of this Area with another.

Definition.

pub fn almost_includes_area(&self, other: &Area<MCL, MCC, MPL, S>) -> bool

Returns whether an Area almost includes another area, that is, if the other Area would be included by this if [Area] if it had the same [SubspaceId`].

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

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

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

fn partial_cmp(&self, other: &Area<MCL, MCC, MPL, S>) -> 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<const MCL: usize, const MCC: usize, const MPL: usize, S> RelativeDecodable<Area<MCL, MCC, MPL, S>, Blame> for Area<MCL, MCC, MPL, S>

where S: SubspaceId + DecodableCanonic, Blame: From<S::ErrorReason> + From<S::ErrorCanonic>,

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

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

Decodes an Area relative to another Area which includes it.

Will return an error if the encoding has not been produced by the corresponding encoding function.

Definition.

fn relative_decode_from_slice( enc: &[u8], r: &RelativeTo, ) -> impl Future<Output = Result<Self, DecodeError<(), Infallible, ErrorReason>>>

Decodes from a slice instead of a producer.

impl<const MCL: usize, const MCC: usize, const MPL: usize, N: NamespaceId, S> RelativeDecodable<PrivateAreaContext<MCL, MCC, MPL, N, S>, Blame> for Area<MCL, MCC, MPL, S>

where S: Decodable + SubspaceId, Blame: From<S::ErrorReason>,

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

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

Decodes the bytes produced by the given producer into a Self, or yields an error if the producer does not produce a valid encoding.

fn relative_decode_from_slice( enc: &[u8], r: &RelativeTo, ) -> impl Future<Output = Result<Self, DecodeError<(), Infallible, ErrorReason>>>

Decodes from a slice instead of a producer.

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

where S: SubspaceId + DecodableCanonic, Blame: From<S::ErrorReason> + From<S::ErrorCanonic>,

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

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

Decodes the bytes produced by the given producer into a Self, and errors if the input encoding is not the canonical one.

fn relative_decode_canonic_from_slice( enc: &[u8], r: &RelativeTo, ) -> impl Future<Output = Result<Self, DecodeError<(), Infallible, ErrorCanonic>>>

Decodes from a slice instead of a producer, and errors if the input encoding is not the canonical one.

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

where S: SubspaceId + DecodableCanonic, Blame: From<S::ErrorReason> + From<S::ErrorCanonic>,

fn sync_relative_decode_from_slice( enc: &[u8], r: &RelativeTo, ) -> Result<Self, DecodeError<(), Infallible, ErrorReason>>

Synchronously decodes from a slice instead of a producer.

fn sync_relative_decode_canonic_from_slice<ErrorCanonic>( enc: &[u8], r: &RelativeTo, ) -> Result<Self, DecodeError<(), Infallible, ErrorCanonic>>

where ErrorCanonic: From<ErrorReason>, Self: RelativeDecodableCanonic<RelativeTo, ErrorReason, ErrorCanonic>,

Synchronously decodes from a slice instead of a producer, 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: SubspaceId + Encodable,

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

where C: BulkConsumer<Item = u8>,

Encodes this Area relative to another Area which includes it.

Definition.

fn relative_encode_into_vec( &self, r: &RelativeTo, ) -> impl Future<Output = Vec<u8>>

Encodes into a Vec instead of a given consumer.

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

where S: Encodable + SubspaceId,

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

where C: BulkConsumer<Item = u8>,

Writes an encoding of &self into the given consumer.

fn relative_encode_into_vec( &self, r: &RelativeTo, ) -> impl Future<Output = Vec<u8>>

Encodes into a Vec instead of a given consumer.

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

where S: SubspaceId + EncodableKnownSize,

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

Computes the size of the encoding in bytes. Calling encode must feed exactly that many bytes into the consumer.

fn relative_encode_into_boxed_slice( &self, r: &RelativeTo, ) -> impl Future<Output = Box<[u8]>>

Encodes into a boxed slice instead of a given consumer.

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

where S: SubspaceId + EncodableSync,

fn sync_relative_encode_into_vec(&self, r: &RelativeTo) -> Vec<u8>

Synchronously encodes into a Vec instead of a given consumer.

fn sync_relative_encode_into_boxed_slice(&self, r: &RelativeTo) -> Box<[u8]>

where Self: RelativeEncodableKnownSize<RelativeTo>,

Synchronously encodes into a boxed slice instead of a given 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>