Skip to main content

TriangularArb

Struct TriangularArb 

Source
pub struct TriangularArb {
    pub currency_a: String,
    pub currency_b: String,
    pub currency_c: String,
    pub rate_ab: f64,
    pub rate_bc: f64,
    pub rate_ca: f64,
    pub profit_pct: f64,
}
Expand description

A detected triangular arbitrage opportunity across three currencies.

§Example

use fin_primitives::arbitrage::TriangularArb;

// USD -> EUR -> GBP -> USD cycle
let arb = TriangularArb::detect(1.10, 1.15, 0.80);
// If rate_ab * rate_bc * rate_ca > 1 there is profit
if let Some(t) = arb {
    assert!(t.profit_pct() > 0.0);
}

Fields§

§currency_a: String

Base currency A.

§currency_b: String

Intermediate currency B.

§currency_c: String

Return currency C.

§rate_ab: f64

Exchange rate A -> B.

§rate_bc: f64

Exchange rate B -> C.

§rate_ca: f64

Exchange rate C -> A.

§profit_pct: f64

Profit percentage: (rate_ab * rate_bc * rate_ca - 1) * 100.

Implementations§

Source§

impl TriangularArb

Source

pub fn detect(rate_ab: f64, rate_bc: f64, rate_ca: f64) -> Option<TriangularArb>

Detect a triangular arbitrage given three cross rates.

Returns Some only when rate_ab * rate_bc * rate_ca > 1.0 (i.e. profit > 0).

Source

pub fn profit_pct(&self) -> f64

Profit percentage of this cycle: (rate_ab * rate_bc * rate_ca - 1.0) * 100.

Trait Implementations§

Source§

impl Clone for TriangularArb

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TriangularArb

Source§

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

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

impl PartialEq for TriangularArb

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for TriangularArb

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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 T
where 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> ToOwned for T
where T: Clone,

Source§

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 T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.