Skip to main content

OkxClientBuilder

rust_okx

Struct OkxClientBuilder 

Source 
pub struct OkxClientBuilder<T = DefaultTransport> { /* private fields */ }
Expand description

Builder for OkxClient.

Created by OkxClient::builder or OkxClient::with_transport.

Implementations§

Source§

impl<T> OkxClientBuilder<T>

Source

pub fn credentials(self, credentials: Credentials) -> Self

Set the API credentials used to sign authenticated requests.

Source

pub fn region(self, region: OkxRegion) -> Self

Select the OKX REST API region.

The default is OkxRegion::Global. US and AU users registered on app.okx.com should use OkxRegion::Us. EU users registered on my.okx.com should use OkxRegion::Eea.

Source

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

Override the API base URL.

This overrides the default global domain and any region selected through Self::region.

Source

pub fn demo_trading(self, demo: bool) -> Self

Toggle the x-simulated-trading header for OKX demo trading.

Source

pub fn transport<U>(self, transport: U) -> OkxClientBuilder<U>

Replace the transport, changing the client’s transport type.

Source

pub fn build(self) -> OkxClient<T>

Build the OkxClient.

Auto Trait Implementations§

§

impl<T> Freeze for OkxClientBuilder<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for OkxClientBuilder<T>
where T: RefUnwindSafe,

§

impl<T> Send for OkxClientBuilder<T>
where T: Send,

§

impl<T> Sync for OkxClientBuilder<T>
where T: Sync,

§

impl<T> Unpin for OkxClientBuilder<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for OkxClientBuilder<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for OkxClientBuilder<T>
where T: UnwindSafe,

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