Enum Index 

pub enum Index {
    DateIndex,
    DecadeIndex,
    DifficultyEpoch,
    EmptyOutputIndex,
    HalvingEpoch,
    Height,
    TxInIndex,
    MonthIndex,
    OpReturnIndex,
    TxOutIndex,
    P2AAddressIndex,
    P2MSOutputIndex,
    P2PK33AddressIndex,
    P2PK65AddressIndex,
    P2PKHAddressIndex,
    P2SHAddressIndex,
    P2TRAddressIndex,
    P2WPKHAddressIndex,
    P2WSHAddressIndex,
    QuarterIndex,
    SemesterIndex,
    TxIndex,
    UnknownOutputIndex,
    WeekIndex,
    YearIndex,
    FundedAddressIndex,
    EmptyAddressIndex,
    PairOutputIndex,
}

Aggregation dimension for querying metrics. Includes time-based (date, week, month, year), block-based (height, txindex), and address/output type indexes.

Variants

DateIndex

DecadeIndex

DifficultyEpoch

EmptyOutputIndex

HalvingEpoch

Height

TxInIndex

MonthIndex

OpReturnIndex

TxOutIndex

P2AAddressIndex

P2MSOutputIndex

P2PK33AddressIndex

P2PK65AddressIndex

P2PKHAddressIndex

P2SHAddressIndex

P2TRAddressIndex

P2WPKHAddressIndex

P2WSHAddressIndex

QuarterIndex

SemesterIndex

TxIndex

UnknownOutputIndex

WeekIndex

YearIndex

FundedAddressIndex

EmptyAddressIndex

PairOutputIndex

Implementations

impl Index

pub const fn all() -> [Self; 28]

pub fn possible_values(&self) -> &'static [&'static str]

pub fn all_possible_values() -> Vec<&'static str>

pub fn serialize_short(&self) -> &'static str

pub fn serialize_long(&self) -> &'static str

pub const fn cost_multiplier(&self) -> usize

Returns the query cost multiplier for this index type. Used for rate limiting to account for expensive lazy computations.

pub const fn is_date_based(&self) -> bool

Returns true if this index type is date-based.

pub fn index_to_date(&self, i: usize) -> Option<Date>

Convert an index value to a date for date-based indexes. Returns None for non-date-based indexes.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Index

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Index

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

Formats the value using the given formatter.

impl Hash for Index

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 JsonSchema for Index

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for Index

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Index

impl Eq for Index

impl StructuralPartialEq for Index