Struct Config 

pub struct Config { /* private fields */ }

Configuration options for Longbridge SDK

Implementations

impl Config

pub fn from_apikey( app_key: impl Into<String>, app_secret: impl Into<String>, access_token: impl Into<String>, ) -> Self

Create a new Config using API Key authentication.

All optional environment variables (LONGBRIDGE_HTTP_URL, LONGBRIDGE_LANGUAGE, LONGBRIDGE_QUOTE_WS_URL, LONGBRIDGE_TRADE_WS_URL, LONGBRIDGE_ENABLE_OVERNIGHT, LONGBRIDGE_PUSH_CANDLESTICK_MODE, LONGBRIDGE_PRINT_QUOTE_PACKAGES, LONGBRIDGE_LOG_PATH) are read from the environment (or .env file) and applied automatically if set.

For OAuth 2.0, use Config::from_oauth together with [longbridge::oauth::OAuthBuilder] instead.

pub fn from_oauth(oauth: OAuth) -> Self

Create a new Config for OAuth 2.0 authentication.

All optional environment variables (LONGBRIDGE_HTTP_URL, LONGBRIDGE_LANGUAGE, LONGBRIDGE_QUOTE_WS_URL, LONGBRIDGE_TRADE_WS_URL, LONGBRIDGE_ENABLE_OVERNIGHT, LONGBRIDGE_PUSH_CANDLESTICK_MODE, LONGBRIDGE_PRINT_QUOTE_PACKAGES, LONGBRIDGE_LOG_PATH) are read from the environment (or .env file) and applied automatically if set.

Arguments

• oauth - An [OAuth] client obtained from [longbridge::oauth::OAuthBuilder].

Example

use std::sync::Arc;

use longbridge::{Config, oauth::OAuthBuilder};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let oauth = OAuthBuilder::new("your-client-id")
        .build(|url| println!("Visit: {url}"))
        .await?;
    let config = Arc::new(Config::from_oauth(oauth));

    let (ctx, receiver) = longbridge::quote::QuoteContext::try_new(config).await?;
    Ok(())
}

pub fn from_apikey_env() -> Result<Self>

Create a new Config from environment variables (API Key authentication).

It first loads the environment variables from the .env file in the current directory.

Variables

• LONGBRIDGE_APP_KEY - App key
• LONGBRIDGE_APP_SECRET - App secret
• LONGBRIDGE_ACCESS_TOKEN - Access token
• LONGBRIDGE_LANGUAGE - Language identifier, zh-CN, zh-HK or en (Default: en)
• LONGBRIDGE_HTTP_URL - HTTP endpoint url (Default: https://openapi.longbridge.com)
• LONGBRIDGE_QUOTE_WS_URL - Quote websocket endpoint url (Default: wss://openapi-quote.longbridge.com/v2)
• LONGBRIDGE_TRADE_WS_URL - Trade websocket endpoint url (Default: wss://openapi-trade.longbridge.com/v2)
• LONGBRIDGE_ENABLE_OVERNIGHT - Enable overnight quote, true or false (Default: false)
• LONGBRIDGE_PUSH_CANDLESTICK_MODE - realtime or confirmed (Default: realtime)
• LONGBRIDGE_PRINT_QUOTE_PACKAGES - Print quote packages when connected, true or false (Default: true)
• LONGBRIDGE_LOG_PATH - Set the path of the log files (Default: no logs)

For OAuth 2.0 authentication use from_oauth together with OAuthBuilder.

pub fn http_url(self, url: impl Into<String>) -> Self

Specifies the url of the OpenAPI server.

Default: https://openapi.longbridge.com

NOTE: Usually you don’t need to change it.

pub fn quote_ws_url(self, url: impl Into<String>) -> Self

Specifies the url of the OpenAPI quote websocket server.

Default: wss://openapi-quote.longbridge.com

NOTE: Usually you don’t need to change it.

pub fn trade_ws_url(self, url: impl Into<String>) -> Self

Specifies the url of the OpenAPI trade websocket server.

Default: wss://openapi-trade.longbridge.com/v2

NOTE: Usually you don’t need to change it.

pub fn language(self, language: Language) -> Self

Specifies the language

Default: Language::EN

pub fn enable_overnight(self) -> Self

Enable overnight quote

Default: false

pub fn push_candlestick_mode(self, mode: PushCandlestickMode) -> Self

Specifies the push candlestick mode

Default: PushCandlestickMode::Realtime

pub fn dont_print_quote_packages(self) -> Self

Disable printing the opened quote packages when connected to the server.

pub fn create_metadata(&self) -> HashMap<String, String>

Create metadata for auth/reconnect request

pub fn log_path(self, path: impl Into<PathBuf>) -> Self

Specifies the path of the log file

Default: None

pub fn set_http_url(&mut self, url: impl Into<String>)

Set the HTTP endpoint URL in place.

pub fn set_quote_ws_url(&mut self, url: impl Into<String>)

Set the quote websocket endpoint URL in place.

pub fn set_trade_ws_url(&mut self, url: impl Into<String>)

Set the trade websocket endpoint URL in place.

pub fn set_language(&mut self, language: Language)

Set the language in place.

pub fn set_enable_overnight(&mut self)

Enable overnight quote in place.

pub fn set_push_candlestick_mode(&mut self, mode: PushCandlestickMode)

Set the push candlestick mode in place.

pub fn set_dont_print_quote_packages(&mut self)

Disable printing quote packages in place.

pub fn set_log_path(&mut self, path: impl Into<PathBuf>)

Set the log path in place.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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.