Struct Area

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

A grouping of entries. Definition.

Implementations

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

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

Create a new Area.

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

Return 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>

Return 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>

Return 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

Return an Area which includes all entries. Definition.

pub fn new_subspace(sub: S) -> Self

Return an Area which includes all entries within a subspace. Definition.

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

Return whether an Area includes an Entry.

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

Return whether an Area fully includes another Area.

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

Return the intersection of this Area with another. Definition.

Trait Implementations

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

where S: SubspaceId + Arbitrary<'a>,

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

Generate an arbitrary value of Self from 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 arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of 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.

impl<const MCL: usize, const MCC: usize, const MPL: usize, S: Clone + SubspaceId> Clone for Area<MCL, MCC, MPL, S>

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

Returns a copy 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 + SubspaceId> 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: Ord + SubspaceId> 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 + SubspaceId> 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 + SubspaceId> 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>> for Area<MCL, MCC, MPL, S>

where S: SubspaceId + Decodable,

async fn relative_decode<Producer>( out: &Area<MCL, MCC, MPL, S>, producer: &mut Producer, ) -> Result<Self, DecodeError<Producer::Error>>

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

Decode an Area relative to another Area which includes it.

Definition.

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: SubspaceId + Decodable,

fn relative_decode<Producer>( out: &Area<MCL, MCC, MPL, S>, producer: &mut Producer, ) -> Result<Self, DecodeError<Producer::Error>>

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

Decode an Area relative to another Area which includes it.

Definition.

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<Consumer>( &self, out: &Area<MCL, MCC, MPL, S>, consumer: &mut Consumer, ) -> Result<(), Consumer::Error>

where Consumer: BulkConsumer<Item = u8>,

Encode an Area relative to another Area which includes it.

Definition.

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,

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

where Consumer: BulkConsumer<Item = u8>,

Encode an Area relative to another Area which includes it.

Definition.

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

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