Enum Index 

pub enum Index {
    Minute10,
    Minute30,
    Hour1,
    Hour4,
    Hour12,
    Day1,
    Day3,
    Week1,
    Month1,
    Month3,
    Month6,
    Year1,
    Year10,
    Halving,
    Epoch,
    Height,
    TxIndex,
    TxInIndex,
    TxOutIndex,
    EmptyOutputIndex,
    OpReturnIndex,
    P2AAddrIndex,
    P2MSOutputIndex,
    P2PK33AddrIndex,
    P2PK65AddrIndex,
    P2PKHAddrIndex,
    P2SHAddrIndex,
    P2TRAddrIndex,
    P2WPKHAddrIndex,
    P2WSHAddrIndex,
    UnknownOutputIndex,
    FundedAddrIndex,
    EmptyAddrIndex,
}

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

Variants

Minute10

Minute30

Hour1

Hour4

Hour12

Day1

Day3

Week1

Month1

Month3

Month6

Year1

Year10

Halving

Epoch

Height

TxIndex

TxInIndex

TxOutIndex

EmptyOutputIndex

OpReturnIndex

P2AAddrIndex

P2MSOutputIndex

P2PK33AddrIndex

P2PK65AddrIndex

P2PKHAddrIndex

P2SHAddrIndex

P2TRAddrIndex

P2WPKHAddrIndex

P2WSHAddrIndex

UnknownOutputIndex

FundedAddrIndex

EmptyAddrIndex

Implementations

impl Index

pub const fn all() -> [Index; 33]

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

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

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

pub const fn cache_class(&self) -> CacheClass

Classifies how the trailing edge of an index mutates, so the series cache can pick the right stable-count strategy.

pub const fn is_date_based(&self) -> bool

Returns true if this index type is date-based.

pub fn index_to_timestamp(&self, i: usize) -> Option<Timestamp>

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

pub fn date_to_index(&self, date: Date) -> Option<usize>

Convert a date to an index value for day-precision or coarser indexes. Returns None for sub-daily indexes (use timestamp_to_index instead), non-date-based indexes, or dates before genesis.

pub fn timestamp_to_index(&self, ts: Timestamp) -> Option<usize>

Convert a timestamp to an index value for any date-based index. Works for both sub-daily (minute, hour) and daily+ indexes. Returns None for non-date-based indexes.

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

Convert an index value to a date for day-precision or coarser indexes. Returns None for sub-daily indexes (use index_to_timestamp instead) and 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 Copy for Index

impl Debug for Index

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

Formats the value using the given formatter.

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

fn deserialize<D>( deserializer: D, ) -> Result<Index, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Index

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

Formats the value using the given formatter.

impl Eq for Index

impl Hash for Index

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Index

impl TryFrom<&str> for Index

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Index, <Index as TryFrom<&str>>::Error>

Performs the conversion.