Skip to main content

CoinbaseDataClientConfig

Struct CoinbaseDataClientConfig 

Source
pub struct CoinbaseDataClientConfig {
    pub api_key: Option<String>,
    pub api_secret: Option<String>,
    pub base_url_rest: Option<String>,
    pub base_url_ws: Option<String>,
    pub proxy_url: Option<String>,
    pub environment: CoinbaseEnvironment,
    pub http_timeout_secs: u64,
    pub ws_timeout_secs: u64,
    pub update_instruments_interval_mins: u64,
    pub derivatives_poll_interval_secs: u64,
    pub transport_backend: TransportBackend,
}
Expand description

Configuration for the Coinbase data client.

Fields§

§api_key: Option<String>

CDP API key name (falls back to COINBASE_API_KEY env var).

§api_secret: Option<String>

CDP API secret in PEM format (falls back to COINBASE_API_SECRET env var).

§base_url_rest: Option<String>

Override for the REST API base URL.

§base_url_ws: Option<String>

Override for the WebSocket market data URL.

§proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

§environment: CoinbaseEnvironment

The Coinbase environment to connect to.

§http_timeout_secs: u64

HTTP timeout in seconds.

§ws_timeout_secs: u64

WebSocket timeout in seconds.

§update_instruments_interval_mins: u64

Interval for refreshing instruments in minutes.

§derivatives_poll_interval_secs: u64

Seconds between REST polls for derivatives-only data streams (IndexPriceUpdate, FundingRateUpdate). Coinbase Advanced Trade does not publish these on a WebSocket channel, so they are sourced from periodic /products/{id} fetches.

§transport_backend: TransportBackend

WebSocket transport backend (defaults to Tungstenite).

Implementations§

Source§

impl CoinbaseDataClientConfig

Source

pub fn builder() -> CoinbaseDataClientConfigBuilder

Create an instance of CoinbaseDataClientConfig using the builder syntax

Source§

impl CoinbaseDataClientConfig

Source

pub fn new() -> Self

Creates a new configuration with default settings.

Source

pub fn has_credentials(&self) -> bool

Returns true when credentials are populated and non-empty.

Source

pub fn rest_url(&self) -> String

Returns the REST API base URL, respecting environment and overrides.

Source

pub fn ws_url(&self) -> String

Returns the WebSocket market data URL, respecting environment and overrides.

Trait Implementations§

Source§

impl ClientConfig for CoinbaseDataClientConfig

Source§

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.
Source§

impl Clone for CoinbaseDataClientConfig

Source§

fn clone(&self) -> CoinbaseDataClientConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoinbaseDataClientConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CoinbaseDataClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CoinbaseDataClientConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for CoinbaseDataClientConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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