Struct Config

pub struct Config { /* private fields */ }

Configuration options for LongPort sdk

Implementations

impl Config

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

Create a new Config

pub fn from_env() -> Result<Self>

Create a new Config from the given environment variables

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

Variables

• LONGPORT_APP_KEY - App key
• LONGPORT_APP_SECRET - App secret
• LONGPORT_ACCESS_TOKEN - Access token
• LONGPORT_HTTP_URL - HTTP endpoint url (Default: https://openapi.longportapp.com)
• LONGPORT_QUOTE_WS_URL - Quote websocket endpoint url (Default: wss://openapi-quote.longportapp.com/v2)
• LONGPORT_TRADE_WS_URL - Trade websocket endpoint url (Default: wss://openapi-trade.longportapp.com/v2)
• LONGPORT_ENABLE_OVERNIGHT - Enable overnight quote, true or false (Default: false)
• LONGPORT_PUSH_CANDLESTICK_MODE - realtime or confirmed (Default: realtime)

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

Specifies the url of the OpenAPI server.

Default: https://openapi.longportapp.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.longportapp.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.longportapp.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 create_metadata(&self) -> HashMap<String, String>

Create metadata for auth/reconnect request

pub async fn refresh_access_token( &self, expired_at: Option<OffsetDateTime>, ) -> Result<String>

Gets a new access_token

expired_at - The expiration time of the access token, defaults to 90 days.

Reference: https://open.longportapp.com/en/docs/refresh-token-api

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.