Struct trade::tick::Tick

pub struct Tick(_);

An object carrying the number of ticks per unit of something and representative of its tick size.

Example: BTC is quoted on exchanges up to a precision of 1e-8, i.e. the tick size is 1e-8, so the number of ticks per unit would be 1e8.

Used for both prices and sizes.

Methods

impl Tick

pub fn new(ticks_per_unit: TickUnit) -> Self

Return a new Tick with given ticks_per_unit.

Panics

Panic if ticks_per_unit is 0.

pub fn ticks_per_unit(self) -> TickUnit

Return the number of ticks per unit carried by self.

pub fn ticked(self, unticked: &str) -> Result<TickUnit, ConversionError>

Convert an unticked value, e.g. "0.001" into a value expressed in ticks, e.g. if self.ticks_per_unit == 1000 then this would return Ok(1).

Note

Will truncate extra decimals if self.ticks_per_unit() is too low.

Errors

Return Err if the value is in an incorrect format or if the number of ticks per unit is badly chosen.

Panics

Panic in case of overflow. Should correctly handle numbers up to (at least) 100,000,000,000.00000001 when using a 10^-8 precision, which seems ok.

pub fn unticked(self, ticked: TickUnit) -> Result<String, ConversionError>

Convert a value expressed in ticks back to an unticked value.

Errors

Return Err if the number of ticks per unit does not divide some power of 10.

Panics

Panic in case of overflow.

Trait Implementations

impl PartialEq<Tick> for Tick

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

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

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

This method tests for !=.

impl Clone for Tick

fn clone(&self) -> Tick

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Tick

impl Eq for Tick

impl Debug for Tick

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

Formats the value using the given formatter.

impl Display for Tick

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

Formats the value using the given formatter.

impl Hash for Tick

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

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl Serialize for Tick

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Tick

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

Deserialize this value from the given Serde deserializer.