pub struct PricePoint {
    pub price_notional: Price,
    pub price_usd: PriceCollateralInUsd,
    pub price_base: PriceBaseInQuote,
    pub timestamp: Timestamp,
    pub is_notional_usd: bool,
    pub market_type: MarketType,
    pub publish_time: Option<Timestamp>,
    pub publish_time_usd: Option<Timestamp>,
}
Expand description

All prices in the protocol for a given point in time.

This includes extra information necessary for performing all conversions, such as the MarketType.

Fields§

§price_notional: Price

Price as used internally by the protocol, in terms of collateral and notional.

This is generally less useful for external consumers, where PricePoint::price_usd and PricePoint::price_base are used.

§price_usd: PriceCollateralInUsd

Price of the collateral asset in terms of USD.

This is generally used for reporting of values like PnL and trade volume.

§price_base: PriceBaseInQuote

Price of the base asset in terms of the quote.

§timestamp: Timestamp

Publish time of this price point.

Before deferred execution, this was the block time when the field was added. Since deferred execution, this is a calculated value based on the publish times of individual feeds.

§is_notional_usd: bool

Is the notional asset USD?

Used for avoiding lossy conversions to USD when they aren’t needed.

We do not need to track if the collateral asset is USD, since USD can never be used as collateral directly. Instead, stablecoins would be used, in which case an explicit price to USD is always needed.

§market_type: MarketType

Indicates if this market uses collateral as base or quote, needed for price conversions.

§publish_time: Option<Timestamp>

Latest price publish time for the feeds composing the price, if available

This field will always be empty since implementation of deferred execution.

§publish_time_usd: Option<Timestamp>

Latest price publish time for the feeds composing the price_usd, if available

This field will always be empty since implementation of deferred execution.

Implementations§

source§

impl PricePoint

source

pub fn base_to_collateral(&self, base: Base) -> Collateral

Convert a base value into collateral.

source

pub fn base_to_usd(&self, base: Base) -> Usd

Convert a base value into USD.

source

pub fn collateral_to_base_non_zero( &self, collateral: NonZero<Collateral> ) -> NonZero<Base>

Convert a non-zero collateral value into base.

source

pub fn collateral_to_usd(&self, collateral: Collateral) -> Usd

Convert a collateral value into USD.

source

pub fn usd_to_collateral(&self, usd: Usd) -> Collateral

Convert a USD value into collateral.

source

pub fn collateral_to_usd_non_zero( &self, collateral: NonZero<Collateral> ) -> NonZero<Usd>

Keeps the invariant of a non-zero value

source

pub fn notional_to_usd(&self, notional: Notional) -> Usd

Convert a notional value into USD.

source

pub fn notional_to_collateral(&self, amount: Notional) -> Collateral

Convert an amount in notional into an amount in collateral

source

pub fn collateral_to_notional(&self, amount: Collateral) -> Notional

Convert an amount in collateral into an amount in notional

source

pub fn collateral_to_notional_non_zero( &self, amount: NonZero<Collateral> ) -> NonZero<Notional>

Convert a non-zero amount in collateral into a non-zero amount in notional

Trait Implementations§

source§

impl Clone for PricePoint

source§

fn clone(&self) -> PricePoint

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for PricePoint

source§

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

Formats the value using the given formatter. Read more
source§

impl<'de> Deserialize<'de> for PricePoint

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl JsonSchema for PricePoint

source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
source§

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

Generates a JSON Schema for this type. Read more
§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
source§

impl PartialEq for PricePoint

source§

fn eq(&self, other: &PricePoint) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl Serialize for PricePoint

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Copy for PricePoint

source§

impl Eq for PricePoint

source§

impl StructuralEq for PricePoint

source§

impl StructuralPartialEq for PricePoint

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<U> As for U

§

fn as_<T>(self) -> Twhere T: CastFrom<U>,

Casts self to type T. The semantics of numeric casting with the as operator are followed, so <T as As>::as_::<U> can be used in the same way as T as U for numeric conversions. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> DynClone for Twhere T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> QueryResultExt for Twhere T: Serialize,

source§

fn query_result(&self) -> Result<Binary, Error>

Convert the value to its JSON representation
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,