Struct TardisHttpClient 

pub struct TardisHttpClient { /* private fields */ }

A Tardis HTTP API client. See https://docs.tardis.dev/api/http.

Implementations

impl TardisHttpClient

pub fn new( api_key: Option<&str>, base_url: Option<&str>, timeout_secs: Option<u64>, normalize_symbols: bool, proxy_url: Option<String>, ) -> Result<Self>

Creates a new TardisHttpClient instance.

Errors

Returns an error if no API key is provided (argument or TARDIS_API_KEY env var), or if the HTTP client cannot be built.

pub const fn credential(&self) -> Option<&Credential>

Returns the credential associated with this client.

pub async fn instruments_info( &self, exchange: TardisExchange, symbol: Option<&str>, filter: Option<&InstrumentFilter>, ) -> Result<Vec<TardisInstrumentInfo>>

Returns all Tardis instrument definitions for the given exchange.

Errors

Returns an error if the HTTP request fails or the response cannot be parsed.

See https://docs.tardis.dev/api/instruments-metadata-api.

pub async fn instruments( &self, exchange: TardisExchange, symbol: Option<&str>, filter: Option<&InstrumentFilter>, start: Option<UnixNanos>, end: Option<UnixNanos>, available_offset: Option<UnixNanos>, effective: Option<UnixNanos>, ts_init: Option<UnixNanos>, ) -> Result<Vec<InstrumentAny>>

Returns all Nautilus instrument definitions for the given exchange, and filter params.

Errors

Returns an error if fetching instrument info or parsing into domain types fails.

See https://docs.tardis.dev/api/instruments-metadata-api.

pub async fn bootstrap_instruments( &self, exchanges: &AHashSet<TardisExchange>, ) -> Result<(AHashMap<TardisInstrumentKey, Arc<TardisInstrumentMiniInfo>>, Vec<InstrumentAny>)>

Fetches instruments for the given exchanges, builds the mini-info map for WS message parsing, and parses Nautilus instrument definitions.

Returns a tuple of (instrument_map, nautilus_instruments). The caller decides how to use each half: data.rs emits instruments via the data sender; replay.rs only needs the map.

Errors

Returns an error if fetching instrument info for any exchange fails.

Trait Implementations

impl Clone for TardisHttpClient

fn clone(&self) -> TardisHttpClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TardisHttpClient

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

Formats the value using the given formatter.

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

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 TardisHttpClient

type Target = TardisHttpClient

The Python output type

type Output = Bound<'py, <TardisHttpClient 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 TardisHttpClient

const NAME: &str = "TardisHttpClient"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for TardisHttpClient

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 = /// A Tardis HTTP API client. /// See <https://docs.tardis.dev/api/http>.

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 = <<TardisHttpClient as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<TardisHttpClient>

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

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 TardisHttpClient

const TEXT_SIGNATURE: &'static str = "(api_key=None, base_url=None, timeout_secs=None, normalize_symbols=True, proxy_url=None)"

impl PyStubType for TardisHttpClient

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 TardisHttpClient

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 DerefToPyAny for TardisHttpClient