Struct pyth_sdk::PriceFeed

#[repr(C)]
pub struct PriceFeed {
    pub id: PriceIdentifier,
    /* private fields */
}

Represents a current aggregation price from pyth publisher feeds.

Fields

id: PriceIdentifier

Unique identifier for this price.

Implementations

impl PriceFeed

pub fn new(id: PriceIdentifier, price: Price, ema_price: Price) -> PriceFeed

Constructs a new Price Feed

pub fn get_price_unchecked(&self) -> Price

Get the “unchecked” price and confidence interval as fixed-point numbers of the form a * 10^e along with its publish time.

Returns a Price struct containing the current price, confidence interval, and the exponent for both numbers, and publish time. This method returns the latest price which may be from arbitrarily far in the past, and the caller should probably check the timestamp before using it.

Please consider using get_price_no_older_than when possible.

pub fn get_ema_price_unchecked(&self) -> Price

Get the “unchecked” exponentially-weighted moving average (EMA) price and a confidence interval on the result along with its publish time.

Returns the latest EMA price value which may be from arbitrarily far in the past, and the caller should probably check the timestamp before using it.

At the moment, the confidence interval returned by this method is computed in a somewhat questionable way, so we do not recommend using it for high-value applications.

Please consider using get_ema_price_no_older_than when possible.

pub fn get_price_no_older_than(
    &self,
    current_time: UnixTimestamp,
    age: DurationInSeconds
) -> Option<Price>

Get the price as long as it was updated within age seconds of the current_time.

This function is a sanity-checked version of get_price_unchecked which is useful in applications that require a sufficiently-recent price. Returns None if the price wasn’t updated sufficiently recently.

Returns a struct containing the latest available price, confidence interval and the exponent for both numbers, or None if no price update occurred within age seconds of the current_time.

pub fn get_ema_price_no_older_than(
    &self,
    current_time: UnixTimestamp,
    age: DurationInSeconds
) -> Option<Price>

Get the exponentially-weighted moving average (EMA) price as long as it was updated within age seconds of the current_time.

This function is a sanity-checked version of get_ema_price_unchecked which is useful in applications that require a sufficiently-recent price. Returns None if the price wasn’t updated sufficiently recently.

Returns a struct containing the EMA price, confidence interval and the exponent for both numbers, or None if no price update occurred within age seconds of the current_time.

Trait Implementations

impl BorshDeserialize for PriceFeedwhere
    PriceIdentifier: BorshDeserialize,
    Price: BorshDeserialize,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

impl BorshSerialize for PriceFeedwhere
    PriceIdentifier: BorshSerialize,
    Price: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

impl Clone for PriceFeed

fn clone(&self) -> PriceFeed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PriceFeed

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

Formats the value using the given formatter.

impl Default for PriceFeed

fn default() -> PriceFeed

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PriceFeed

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

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PriceFeed

fn schema_name() -> String

The name of the generated JSON Schema.

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

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

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

impl PartialEq<PriceFeed> for PriceFeed

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

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

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.

impl Serialize for PriceFeed

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

Serialize this value into the given Serde serializer.

impl Copy for PriceFeed

impl Eq for PriceFeed

impl StructuralEq for PriceFeed

impl StructuralPartialEq for PriceFeed