Enum Aggregator

pub enum Aggregator {
    None,
    Some(SubAggregator),
    Take(SubAggregator),
    Or(SubAggregator, SubAggregator),
    AluVM(LibSite),
}

A set of pre-defined top-level state aggregators (see crate::Api::aggregators.

Variants

None

Produces constant value of Option::None type.

Some(SubAggregator)

Wrap into an optional value.

If the underlying aggregated state fails, sets the aggregated state to None.

Take(SubAggregator)

Takes the underlying aggregated state and applies nothing on top.

If the underlying aggregator fails, the aggregated state is not produced.

Or(SubAggregator, SubAggregator)

If the underlying aggregated state fails, returns the other state.

If the other state fails, the aggregated state is not produced.

AluVM(LibSite)

Execute a custom function on the state.

Tuple Fields

0: LibSite

The entry point to the script (virtual machine uses libraries from crate::Semantics).

Implementations

impl Aggregator

pub fn depends_on(&self) -> impl Iterator<Item = &StateName>

Returns names of the other computed state which this aggregator depends on and which needs to be computed before running this aggregator.

pub fn aggregate<'libs>( &self, global: &BTreeMap<StateName, BTreeMap<CellAddr, StateAtom>>, aggregated: &BTreeMap<StateName, StrictVal>, libs: impl IntoIterator<Item = &'libs Lib>, types: &TypeSystem, ) -> Option<StrictVal>

Compute state via applying some aggregator function.

Returns

Aggregated state value. If the computing fails due to any exception, None.

Trait Implementations

impl Clone for Aggregator

fn clone(&self) -> Aggregator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Aggregator

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Aggregator

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Aggregator

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 Ord for Aggregator

fn cmp(&self, other: &Aggregator) -> 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 PartialEq for Aggregator

fn eq(&self, other: &Aggregator) -> 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 PartialOrd for Aggregator

fn partial_cmp(&self, other: &Aggregator) -> 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 Serialize for Aggregator

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for Aggregator

fn strict_decode(reader: &mut impl TypedRead) -> Result<Self, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDumb for Aggregator

fn strict_dumb() -> Self

impl StrictEncode for Aggregator

fn strict_encode<W: TypedWrite>(&self, writer: W) -> Result<W>

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictSum for Aggregator

const ALL_VARIANTS: &'static [(u8, &'static str)]

fn variant_name(&self) -> &'static str

fn strict_check_variants()

fn variant_name_by_tag(tag: u8) -> Option<VariantName>

fn variant_ord(&self) -> u8

impl StrictType for Aggregator

const STRICT_LIB_NAME: &'static str = LIB_NAME_SONIC

fn strict_name() -> Option<TypeName>

impl StrictUnion for Aggregator

fn strict_type_info() -> TypeInfo<Self>

impl Eq for Aggregator

impl StructuralPartialEq for Aggregator