pub struct Config<I, const D: u8, BaseOrQuote>where
I: Mon<D>,
BaseOrQuote: MarginCurrency<I, D>,{ /* private fields */ }Expand description
Define the Exchange configuration.
Generics:
I: The numeric data type of currencies.D: The constant decimal precision of the currencies.BaseOrQuote: EitherBaseCurrencyorQuoteCurrencydepending on the futures type.
Implementations§
Source§impl<I, const D: u8, BaseOrQuote> Config<I, D, BaseOrQuote>where
I: Mon<D>,
BaseOrQuote: MarginCurrency<I, D>,
impl<I, const D: u8, BaseOrQuote> Config<I, D, BaseOrQuote>where
I: Mon<D>,
BaseOrQuote: MarginCurrency<I, D>,
Sourcepub fn contract_spec(
&self,
) -> &ContractSpecification<I, D, BaseOrQuote::PairedCurrency>
pub fn contract_spec( &self, ) -> &ContractSpecification<I, D, BaseOrQuote::PairedCurrency>
The contract specification.
Sourcepub fn order_rate_limits(&self) -> &OrderRateLimits
pub fn order_rate_limits(&self) -> &OrderRateLimits
The submission rate limits for orders.
Source§impl<I, const D: u8, BaseOrQuote> Config<I, D, BaseOrQuote>where
I: Mon<D>,
BaseOrQuote: MarginCurrency<I, D>,
impl<I, const D: u8, BaseOrQuote> Config<I, D, BaseOrQuote>where
I: Mon<D>,
BaseOrQuote: MarginCurrency<I, D>,
Sourcepub fn starting_wallet_balance(&self) -> BaseOrQuote
pub fn starting_wallet_balance(&self) -> BaseOrQuote
The starting balance of account (denoted in margin currency).
The concrete Currency here defines the futures type.
If QuoteCurrency is used as the margin currency,
then its a linear futures contract.
If BaseCurrency is used as the margin currency,
then its an inverse futures contract.
Sourcepub fn max_num_open_orders(&self) -> NonZeroU16
pub fn max_num_open_orders(&self) -> NonZeroU16
The maximum number of open orders the user can have at any given time.
Source§impl<I, const D: u8, BaseOrQuote> Config<I, D, BaseOrQuote>where
I: Mon<D>,
BaseOrQuote: MarginCurrency<I, D>,
impl<I, const D: u8, BaseOrQuote> Config<I, D, BaseOrQuote>where
I: Mon<D>,
BaseOrQuote: MarginCurrency<I, D>,
Sourcepub fn new(
starting_balance: BaseOrQuote,
max_num_open_orders: NonZeroU16,
contract_specification: ContractSpecification<I, D, BaseOrQuote::PairedCurrency>,
order_rate_limits: OrderRateLimits,
) -> Result<Self, ConfigError>
pub fn new( starting_balance: BaseOrQuote, max_num_open_orders: NonZeroU16, contract_specification: ContractSpecification<I, D, BaseOrQuote::PairedCurrency>, order_rate_limits: OrderRateLimits, ) -> Result<Self, ConfigError>
Create a new Config.
§Arguments:
starting_balance: Initial Wallet Balance, denoted in QUOTE if using
linear futures, denoted in BASE for inverse futures
max_num_open_orders: The maximum number of open ordes a user can have
at any time.
contract_specification: More details on the actual contract traded.
§Returns:
Either a valid Config or an Error
Trait Implementations§
Auto Trait Implementations§
impl<I, const D: u8, BaseOrQuote> Freeze for Config<I, D, BaseOrQuote>where
BaseOrQuote: Freeze,
ContractSpecification<I, D, <BaseOrQuote as Currency<I, D>>::PairedCurrency>: Freeze,
impl<I, const D: u8, BaseOrQuote> RefUnwindSafe for Config<I, D, BaseOrQuote>where
BaseOrQuote: RefUnwindSafe,
ContractSpecification<I, D, <BaseOrQuote as Currency<I, D>>::PairedCurrency>: RefUnwindSafe,
impl<I, const D: u8, BaseOrQuote> Send for Config<I, D, BaseOrQuote>where
BaseOrQuote: Send,
ContractSpecification<I, D, <BaseOrQuote as Currency<I, D>>::PairedCurrency>: Send,
impl<I, const D: u8, BaseOrQuote> Sync for Config<I, D, BaseOrQuote>where
BaseOrQuote: Sync,
ContractSpecification<I, D, <BaseOrQuote as Currency<I, D>>::PairedCurrency>: Sync,
impl<I, const D: u8, BaseOrQuote> Unpin for Config<I, D, BaseOrQuote>where
BaseOrQuote: Unpin,
ContractSpecification<I, D, <BaseOrQuote as Currency<I, D>>::PairedCurrency>: Unpin,
impl<I, const D: u8, BaseOrQuote> UnsafeUnpin for Config<I, D, BaseOrQuote>where
BaseOrQuote: UnsafeUnpin,
ContractSpecification<I, D, <BaseOrQuote as Currency<I, D>>::PairedCurrency>: UnsafeUnpin,
impl<I, const D: u8, BaseOrQuote> UnwindSafe for Config<I, D, BaseOrQuote>where
BaseOrQuote: UnwindSafe,
ContractSpecification<I, D, <BaseOrQuote as Currency<I, D>>::PairedCurrency>: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);