Struct binance::config::Config

pub struct Config {
    pub rest_api_endpoint: String,
    pub ws_endpoint: String,
    pub futures_rest_api_endpoint: String,
    pub futures_ws_endpoint: String,
    pub recv_window: u64,
    pub binance_us_api: bool,
    pub timeout: Option<u64>,
}

Fields

rest_api_endpoint: String

ws_endpoint: String

futures_rest_api_endpoint: String

futures_ws_endpoint: String

recv_window: u64

binance_us_api: bool

timeout: Option<u64>

Implementations

impl Config

pub fn testnet() -> Config

Configure binance with all testnet endpoints

Examples

use binance::config::Config;
let config = Config::testnet();

pub fn set_rest_api_endpoint<T: Into<String>>(self, rest_api_endpoint: T) -> Self

Sets the rest api endpoint. Defaults to https://api.binance.com.

Arguments

• rest_api_endpoint:

returns: Config

Examples

use binance::config::Config;
let config = Config::default();
config.set_rest_api_endpoint("http://myendpoint:8080");

pub fn set_ws_endpoint<T: Into<String>>(self, ws_endpoint: T) -> Self

Sets the websocket endpoint. Defaults to “wss://stream.binance.com:9443”.

Arguments

• ws_endpoint:

returns: Config

Examples

use binance::config::Config;
let config = Config::default();
config.set_ws_endpoint("ws://myendpoint:8080");

pub fn set_futures_rest_api_endpoint<T: Into<String>>(
    self,
    futures_rest_api_endpoint: T
) -> Self

Sets the futures rest api endpoint. Defaults to https://fapi.binance.com.

Arguments

• futures_rest_api_endpoint:

returns: Config

Examples

use binance::config::Config;
let config = Config::default();
config.set_futures_rest_api_endpoint("http://myendpoint:8080");

pub fn set_futures_ws_endpoint<T: Into<String>>(
    self,
    futures_ws_endpoint: T
) -> Self

Sets the futures websocket endpoint. Defaults to “wss://fstream.binance.com”.

Arguments

• futures_ws_endpoint:

returns: Config

Examples

use binance::config::Config;
let config = Config::default();
config.set_futures_ws_endpoint("ws://myendpoint:8080");

pub fn set_recv_window(self, recv_window: u64) -> Self

Sets the ‘receive window’. The receive window is the number of milliseconds after timestamp the request is valid for.

Arguments

• recv_window: The receive window, in milliseconds. Defaults to 5000.

returns: Config

Examples

use binance::config::Config;
let config = Config::default();
config.set_recv_window(300);

pub fn set_timeout(self, timeout: u64) -> Self

Sets the client timeout

Arguments

• timeout: The timeout, in seconds

returns: Config

Examples

use binance::config::Config;
let config = Config::default();
config.set_timeout(3);

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Configure binance with default production endpoints

Examples

use binance::config::Config;
let config = Config::default();

impl PartialEq<Config> for Config

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

impl StructuralEq for Config

impl StructuralPartialEq for Config