Struct hydradx_traits::oracle::Volume

pub struct Volume<Balance> {
    pub a_in: Balance,
    pub b_out: Balance,
    pub a_out: Balance,
    pub b_in: Balance,
}

Struct to represent trade volume for an asset pair.

Fields

a_in: Balance

b_out: Balance

a_out: Balance

b_in: Balance

Implementations

impl<Balance> Volume<Balance>where
    Balance: Copy + AtLeast32BitUnsigned,

pub fn from_a_in_b_out(a_in: Balance, b_out: Balance) -> Self

Constructor for volume flowing based on trades from asset a to asset b.

pub fn from_a_out_b_in(a_out: Balance, b_in: Balance) -> Self

Constructor for volume flowing based on trades from asset b to asset a.

pub fn saturating_add(&self, rhs: &Self) -> Self

Utility function that sums the underlying values of the volumes.

pub fn cumulative_volume(&self) -> (Balance, Balance)

Returns the cumulative volume as (cumulative_a, cumulative_b).

pub fn inverted(self) -> Self

Switch assets a and b, so the new a_in refers to old b_in etc.

Trait Implementations

impl<Balance: Clone> Clone for Volume<Balance>

fn clone(&self) -> Volume<Balance>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Balance> Debug for Volume<Balance>where
    Balance: Debug,

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

Formats the value using the given formatter.

impl<Balance> Decode for Volume<Balance>where
    Balance: Decode,

fn decode<__CodecInputEdqy: Input>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<Balance: Default> Default for Volume<Balance>

fn default() -> Volume<Balance>

Returns the “default value” for a type.

impl<'de, Balance> Deserialize<'de> for Volume<Balance>where
    Balance: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<Balance> Encode for Volume<Balance>where
    Balance: Encode,

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

Convert self to a slice and append it to the destination.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<Balance> From<(Balance, Balance, Balance, Balance)> for Volume<Balance>

fn from(
    (a_in, b_out, a_out, b_in): (Balance, Balance, Balance, Balance)
) -> Self

Converts to this type from the input type.

impl<Balance> From<Volume<Balance>> for (Balance, Balance, Balance, Balance)

fn from(_: Volume<Balance>) -> Self

Converts to this type from the input type.

impl<Balance> MaxEncodedLen for Volume<Balance>where
    Balance: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<Balance: PartialEq> PartialEq<Volume<Balance>> for Volume<Balance>

fn eq(&self, other: &Volume<Balance>) -> 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<Balance> Serialize for Volume<Balance>where
    Balance: Serialize,

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

Serialize this value into the given Serde serializer.

impl<Balance> TypeInfo for Volume<Balance>where
    Balance: TypeInfo + 'static,

type Identity = Volume<Balance>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Balance> EncodeLike<Volume<Balance>> for Volume<Balance>where
    Balance: Encode,

impl<Balance: Eq> Eq for Volume<Balance>

impl<Balance> StructuralEq for Volume<Balance>

impl<Balance> StructuralPartialEq for Volume<Balance>