Skip to main content

Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

Constructor configuration for an exchange, without exposing Value.

ⓘ
let ex = Binance::with_config(
    Config::new()
        .api_key(&key)
        .secret(&secret)
        .sandbox(true)
        .option_strs("fetchMarkets.types", &["spot"]),
);

options nests exactly the way it does in every other ccxt binding. What the manual writes as

{ "options": { "fetchMarkets": { "types": ["spot"] } } }

is built with Config::option and a nested Params:

ⓘ
Config::new().option("fetchMarkets", Params::new().with_strs("types", &["spot"]))

Use Config::option_str and friends for a flat key (options: { defaultType: "swap" }), or Config::options to hand over the whole block at once.

Implementations§

Source§

impl Config

Source

pub fn new() -> Config

Source

pub fn none() -> Config

No configuration — same as Config::new(), clearer at a call site.

Source

pub fn api_key(self, v: &str) -> Config

Source

pub fn secret(self, v: &str) -> Config

Source

pub fn password(self, v: &str) -> Config

Source

pub fn uid(self, v: &str) -> Config

Source

pub fn wallet_address(self, v: &str) -> Config

Source

pub fn private_key(self, v: &str) -> Config

Source

pub fn token(self, v: &str) -> Config

Source

pub fn sandbox(self, on: bool) -> Config

Route to the venue’s testnet / demo endpoints.

Source

pub fn enable_rate_limit(self, on: bool) -> Config

Client-side rate limiting (on by default in ccxt).

Source

pub fn rate_limit_ms(self, ms: i64) -> Config

Milliseconds per rate-limit token.

Source

pub fn timeout_ms(self, ms: i64) -> Config

Request timeout in milliseconds.

Source

pub fn verbose(self, on: bool) -> Config

Log every request and response.

Source

pub fn set_str(self, key: &str, v: &str) -> Config

Set an arbitrary top-level property.

Source

pub fn set_int(self, key: &str, v: i64) -> Config

Source

pub fn set_float(self, key: &str, v: f64) -> Config

Source

pub fn set_bool(self, key: &str, v: bool) -> Config

Source

pub fn options(self, options: Params) -> Config

Merge a whole options block in — the closest match to passing an options dict wholesale in the other language bindings. Deep-merges, so it composes with anything already set (sandbox, earlier option calls) instead of discarding it.

Source

pub fn option(self, key: &str, value: Params) -> Config

Set one nested object under options, e.g. option("fetchMarkets", Params::new().with_strs("types", &["spot"])) for options: { fetchMarkets: { types: ["spot"] } }.

Calling it twice with the same key MERGES the two objects, so nested options can be built up across several calls.

Source

pub fn option_str(self, key: &str, v: &str) -> Config

Set a flat entry under options. The key is taken literally.

Source

pub fn option_int(self, key: &str, v: i64) -> Config

Source

pub fn option_float(self, key: &str, v: f64) -> Config

Source

pub fn option_bool(self, key: &str, v: bool) -> Config

Source

pub fn option_strs(self, key: &str, values: &[&str]) -> Config

Source

pub fn into_value(self) -> Value

Lower to the dynamic representation the transpiled core consumes.

Source

pub fn into_option(self) -> Option<Value>

Some(value) for the generated new(Option<Value>) constructors.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

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 Config

Source§

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

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

impl Default for Config

Source§

fn default() -> Config

Returns the “default value” for a type. Read more
Source§

impl From<Config> for Value

Source§

fn from(c: Config) -> Value

Converts to this type from the input type.
Source§

impl PartialEq for Config

Source§

fn eq(&self, other: &Config) -> 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 Config

Auto Trait Implementations§

§

impl Forget for Config

§

impl Freeze for Config

§

impl Move for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnsafeUnpin for Config

§

impl UnwindSafe for Config

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more