Struct KrakenDataClientConfig 

pub struct KrakenDataClientConfig {

    pub api_key: Option<String>,
    pub api_secret: Option<String>,
    pub product_type: KrakenProductType,
    pub environment: KrakenEnvironment,
    pub base_url: Option<String>,
    pub ws_public_url: Option<String>,
    pub ws_private_url: Option<String>,
    pub ws_l3_url: Option<String>,
    pub validate_l3_checksum: bool,
    pub proxy_url: Option<String>,
    pub timeout_secs: u64,
    pub heartbeat_interval_secs: u64,
    pub ws_idle_timeout_ms: u64,
    pub max_requests_per_second: Option<u32>,
    pub transport_backend: TransportBackend,
}

Configuration for the Kraken data client.

Fields

api_key: Option<String>

api_secret: Option<String>

product_type: KrakenProductType

environment: KrakenEnvironment

base_url: Option<String>

ws_public_url: Option<String>

ws_private_url: Option<String>

ws_l3_url: Option<String>

Override for the L3 WebSocket URL. Defaults to wss://ws-l3.kraken.com/v2.

validate_l3_checksum: bool

Validate Kraken’s CRC32 checksum on each L3 update.

proxy_url: Option<String>

Optional proxy URL for HTTP and WebSocket transports.

timeout_secs: u64

heartbeat_interval_secs: u64

ws_idle_timeout_ms: u64

Idle timeout (milliseconds) for the spot v2 WebSocket.

If no application data (any text or binary frame) is received within this window, the connection is treated as dead and the client reconnects and resubscribes. This recovers from a backend that acknowledges a subscription but never attaches the data fan-out: the socket stays open with no close frame or transport error, so nothing else detects it.

Kraken sends a heartbeat text frame once per second while at least one subscription is active, so a live subscribed connection resets this timer well within the window. Note the client’s keepalive ping is answered with a pong text frame, which also resets the timer roughly every heartbeat_interval_secs; the default below is therefore kept short enough to rely on the 1/s heartbeats rather than the keepalive, which assumes the connection carries at least one subscription. A connection held open without any subscription should disable this (0) or raise it above heartbeat_interval_secs.

0 disables the idle timeout.

max_requests_per_second: Option<u32>

transport_backend: TransportBackend

Implementations

impl KrakenDataClientConfig

pub fn builder() -> KrakenDataClientConfigBuilder

Create an instance of KrakenDataClientConfig using the builder syntax

impl KrakenDataClientConfig

pub fn validate(&self) -> Result<()>

Validates config invariants.

Errors

Returns an error if the demo environment is used for Spot.

pub fn has_api_credentials(&self) -> bool

Returns true if both API key and secret are set.

pub fn http_base_url(&self) -> String

Returns the HTTP base URL for the configured product type and environment.

pub fn ws_public_url(&self) -> String

Returns the public WebSocket URL for the configured product type and environment.

pub fn ws_private_url(&self) -> String

Returns the private WebSocket URL for the configured product type and environment.

pub fn ws_l3_url(&self) -> String

Returns the L3 WebSocket URL for the configured environment.

Trait Implementations

impl ClientConfig for KrakenDataClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for KrakenDataClientConfig

fn clone(&self) -> KrakenDataClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KrakenDataClientConfig

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

Formats the value using the given formatter.

impl Default for KrakenDataClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for KrakenDataClientConfig

impl<'de> Deserialize<'de> for KrakenDataClientConfig

where KrakenDataClientConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, 'py> FromPyObject<'a, 'py> for KrakenDataClientConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for KrakenDataClientConfig

type Target = KrakenDataClientConfig

The Python output type

type Output = Bound<'py, <KrakenDataClientConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for KrakenDataClientConfig

const NAME: &str = "KrakenDataClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for KrakenDataClientConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for the Kraken data client.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<KrakenDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<KrakenDataClientConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForKrakenDataClientConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for KrakenDataClientConfig

const TEXT_SIGNATURE: &'static str = "(product_type=None, environment=None, api_key=None, api_secret=None, base_url=None, ws_public_url=None, ws_private_url=None, ws_l3_url=None, validate_l3_checksum=None, proxy_url=None, timeout_secs=None, heartbeat_interval_secs=None, ws_idle_timeout_ms=None, max_requests_per_second=None)"

impl PyStubType for KrakenDataClientConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for KrakenDataClientConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for KrakenDataClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.