Client

Struct Client 

Source
pub struct Client {
    pub news: NewsService,
    pub common: CommonService,
    pub market: MarketService,
    pub delivery: DeliveryService,
    pub member: MemberService,
    pub trade: TradeService,
    pub settle: SettleService,
    /* private fields */
}
Expand description

DCE API client.

This is the main entry point for using the DCE API. It provides access to all API services through dedicated service instances.

§Example

use dceapi::{Client, Config};

#[tokio::main]
async fn main() -> dceapi::Result<()> {
    let config = Config::new()
        .with_api_key("your-api-key")
        .with_secret("your-secret");
     
    let client = Client::new(config)?;
     
    // Get current trade date
    let trade_date = client.common.get_curr_trade_date(None).await?;
    println!("Trade date: {}", trade_date.date);
     
    Ok(())
}

Fields§

§news: NewsService

News service for articles and announcements.

§common: CommonService

Common service for trade dates and varieties.

§market: MarketService

Market service for quotes and market data.

§delivery: DeliveryService

Delivery service for delivery data.

§member: MemberService

Member service for member rankings.

§trade: TradeService

Trade service for trading parameters.

§settle: SettleService

Settlement service for settlement parameters.

Implementations§

Source§

impl Client

Source

pub fn new(config: Config) -> Result<Self>

Create a new DCE API client.

§Arguments
  • config - Client configuration with API credentials
§Errors

Returns an error if the configuration is invalid (missing API key or secret).

§Example
use dceapi::{Client, Config};

let config = Config::new()
    .with_api_key("your-api-key")
    .with_secret("your-secret");

let client = Client::new(config).expect("Failed to create client");
Source

pub fn from_env() -> Result<Self>

Create a new client from environment variables.

Reads DCE_API_KEY and DCE_SECRET from the environment.

§Errors

Returns an error if the environment variables are not set.

Source

pub fn config(&self) -> &Config

Get the client configuration (read-only).

Source

pub fn token_manager(&self) -> &TokenManager

Get the token manager.

This can be used for advanced token management, such as forcing a refresh.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

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: 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: 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> 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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<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