pub struct FinFeedDataClientConfig {
pub api_key: Option<SecretString>,
pub http: FinFeedHttpConfig,
pub instruments: Vec<FinFeedInstrumentSelection>,
pub poll_interval_ms: u64,
pub poll_limit: u32,
pub connect_timeout_secs: u64,
}Expand description
Explicit startup selections and bounded REST, bootstrap, and polling controls.
§Bootstrap
connect_timeout_secs bounds the whole bootstrap, including request admission.
Selections and controls are validated when building the client, before network requests.
§Python Configuration
Python exposes nested Rust HTTP controls as flat constructor keywords:
http:base_url_http,proxy_url,http_timeout_secs,max_concurrent_requests,attempt_budget,min_request_interval_ms, andkalshi_metadata_url.http.retry:max_retries,retry_delay_initial_ms,retry_delay_max_ms,retry_backoff_factor,retry_jitter_ms,retry_operation_timeout_ms,retry_immediate_first, andretry_max_elapsed_ms.
Omitted or None options use Rust defaults. Configuration construction rejects unknown
keywords and wrong types. API keys and proxy URLs expose presence indicators instead of
plaintext getters.
§Credentials
Creating a config does not read credentials or connect. If api_key is absent, the data
client reads FINFEED_API_KEY once at client construction.
Fields§
§api_key: Option<SecretString>Explicit key, or FINFEED_API_KEY read once at client construction and reused on reconnect.
http: FinFeedHttpConfigREST transport, pacing, retry, and local attempt controls for each connection generation.
instruments: Vec<FinFeedInstrumentSelection>Exact Polymarket or Kalshi Yes/No outcomes loaded and published before readiness.
poll_interval_ms: u64Delay after each instrument’s poll on the same endpoint completes, in milliseconds, in [100, 86400000].
poll_limit: u32Maximum latest trades and quotes per poll, independently, in [1, 10000].
OHLCV requests add one record slot for a running period, within the endpoint limit.
connect_timeout_secs: u64Whole bootstrap deadline in seconds, including request admission.
Implementations§
Source§impl FinFeedDataClientConfig
impl FinFeedDataClientConfig
Sourcepub fn builder() -> FinFeedDataClientConfigBuilder
pub fn builder() -> FinFeedDataClientConfigBuilder
Create an instance of FinFeedDataClientConfig using the builder syntax
Trait Implementations§
Source§impl ClientConfig for FinFeedDataClientConfig
impl ClientConfig for FinFeedDataClientConfig
Source§impl Clone for FinFeedDataClientConfig
impl Clone for FinFeedDataClientConfig
Source§impl Debug for FinFeedDataClientConfig
impl Debug for FinFeedDataClientConfig
Source§impl Default for FinFeedDataClientConfig
impl Default for FinFeedDataClientConfig
impl DerefToPyAny for FinFeedDataClientConfig
Source§impl<'de> Deserialize<'de> for FinFeedDataClientConfigwhere
FinFeedDataClientConfig: Default,
impl<'de> Deserialize<'de> for FinFeedDataClientConfigwhere
FinFeedDataClientConfig: Default,
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<'a, 'py> FromPyObject<'a, 'py> for FinFeedDataClientConfigwhere
Self: Clone,
impl<'a, 'py> FromPyObject<'a, 'py> for FinFeedDataClientConfigwhere
Self: Clone,
Source§impl<'py> IntoPyObject<'py> for FinFeedDataClientConfig
impl<'py> IntoPyObject<'py> for FinFeedDataClientConfig
Source§type Target = FinFeedDataClientConfig
type Target = FinFeedDataClientConfig
Source§type Output = Bound<'py, FinFeedDataClientConfig>
type Output = Bound<'py, FinFeedDataClientConfig>
Source§fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>
fn into_pyobject(self, py: Python<'py>) -> PyResult<Bound<'py, Self>>
Source§impl PyClass for FinFeedDataClientConfig
impl PyClass for FinFeedDataClientConfig
Source§impl PyClassImpl for FinFeedDataClientConfig
impl PyClassImpl for FinFeedDataClientConfig
Source§const RAW_DOC: &'static CStr = /// Explicit startup selections and bounded REST, bootstrap, and polling controls.
///
/// # Bootstrap
///
/// `connect_timeout_secs` bounds the whole bootstrap, including request admission.
/// Selections and controls are validated when building the client, before network requests.
///
/// # Python Configuration
///
/// Python exposes nested Rust HTTP controls as flat constructor keywords:
///
/// - `http`: `base_url_http`, `proxy_url`, `http_timeout_secs`, `max_concurrent_requests`,
/// `attempt_budget`, `min_request_interval_ms`, and `kalshi_metadata_url`.
/// - `http.retry`: `max_retries`, `retry_delay_initial_ms`, `retry_delay_max_ms`,
/// `retry_backoff_factor`, `retry_jitter_ms`, `retry_operation_timeout_ms`,
/// `retry_immediate_first`, and `retry_max_elapsed_ms`.
///
/// Omitted or `None` options use Rust defaults. Configuration construction rejects unknown
/// keywords and wrong types. API keys and proxy URLs expose presence indicators instead of
/// plaintext getters.
///
/// # Credentials
///
/// Creating a config does not read credentials or connect. If `api_key` is absent, the data
/// client reads `FINFEED_API_KEY` once at client construction.
const RAW_DOC: &'static CStr = /// Explicit startup selections and bounded REST, bootstrap, and polling controls. /// /// # Bootstrap /// /// `connect_timeout_secs` bounds the whole bootstrap, including request admission. /// Selections and controls are validated when building the client, before network requests. /// /// # Python Configuration /// /// Python exposes nested Rust HTTP controls as flat constructor keywords: /// /// - `http`: `base_url_http`, `proxy_url`, `http_timeout_secs`, `max_concurrent_requests`, /// `attempt_budget`, `min_request_interval_ms`, and `kalshi_metadata_url`. /// - `http.retry`: `max_retries`, `retry_delay_initial_ms`, `retry_delay_max_ms`, /// `retry_backoff_factor`, `retry_jitter_ms`, `retry_operation_timeout_ms`, /// `retry_immediate_first`, and `retry_max_elapsed_ms`. /// /// Omitted or `None` options use Rust defaults. Configuration construction rejects unknown /// keywords and wrong types. API keys and proxy URLs expose presence indicators instead of /// plaintext getters. /// /// # Credentials /// /// Creating a config does not read credentials or connect. If `api_key` is absent, the data /// client reads `FINFEED_API_KEY` once at client construction.
Source§const DOC: &'static CStr
const DOC: &'static CStr
text_signature if a constructor is defined. Read moreSource§type Layout = <<FinFeedDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<FinFeedDataClientConfig>
type Layout = <<FinFeedDataClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<FinFeedDataClientConfig>
Source§type ThreadChecker = NoopThreadChecker
type ThreadChecker = NoopThreadChecker
type Inventory = Pyo3MethodsInventoryForFinFeedDataClientConfig
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Source§type BaseNativeType = PyAny
type BaseNativeType = PyAny
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 __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>
§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
§fn dict_offset() -> Option<PyObjectOffset>
fn dict_offset() -> Option<PyObjectOffset>
§fn weaklist_offset() -> Option<PyObjectOffset>
fn weaklist_offset() -> Option<PyObjectOffset>
Source§impl PyClassNewTextSignature for FinFeedDataClientConfig
impl PyClassNewTextSignature for FinFeedDataClientConfig
const TEXT_SIGNATURE: &'static str = "(api_key=None, base_url_http=None, proxy_url=None, instruments=None, http_timeout_secs=None, max_concurrent_requests=None, attempt_budget=None, min_request_interval_ms=None, max_retries=None, retry_delay_initial_ms=None, retry_delay_max_ms=None, retry_backoff_factor=None, retry_jitter_ms=None, retry_operation_timeout_ms=None, retry_immediate_first=None, retry_max_elapsed_ms=None, poll_interval_ms=None, poll_limit=None, connect_timeout_secs=None, kalshi_metadata_url=None)"
Source§impl PyStubType for FinFeedDataClientConfig
impl PyStubType for FinFeedDataClientConfig
Source§fn type_output() -> TypeInfo
fn type_output() -> TypeInfo
§fn type_input() -> TypeInfo
fn type_input() -> TypeInfo
Source§impl PyTypeInfo for FinFeedDataClientConfig
impl PyTypeInfo for FinFeedDataClientConfig
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
object is an instance of this type or a subclass of this type.§fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool
object is an instance of this type.Auto Trait Implementations§
impl Freeze for FinFeedDataClientConfig
impl RefUnwindSafe for FinFeedDataClientConfig
impl Send for FinFeedDataClientConfig
impl Sync for FinFeedDataClientConfig
impl Unpin for FinFeedDataClientConfig
impl UnsafeUnpin for FinFeedDataClientConfig
impl UnwindSafe for FinFeedDataClientConfig
Blanket Implementations§
impl<T> Allocation for T
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<'py, T> FromPyObjectOwned<'py> for Twhere
T: for<'a> FromPyObject<'a, 'py>,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
self into an owned Python object, dropping type information.§fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>
self into an owned Python object, dropping type information and unbinding it
from the 'py lifetime.§fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>
self into a Python object. Read more§impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
impl<'py, T> IntoPyObjectNautilusExt<'py> for Twhere
T: IntoPyObjectExt<'py>,
§fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>where
Self: IntoPyObject<'py, Error = !>,
fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>where
Self: IntoPyObject<'py, Error = !>,
self into a [Py<PyAny>] when the underlying conversion is infallible.§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
§fn type_check(object: &Bound<'_, PyAny>) -> bool
fn type_check(object: &Bound<'_, PyAny>) -> bool
§fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>
isinstance and issubclass function. Read more