Struct TardisMachineClient 

pub struct TardisMachineClient {
    pub base_url: String,
    pub replay_signal: Arc<AtomicBool>,
    pub stream_signal: Arc<AtomicBool>,
    pub instruments: HashMap<TardisInstrumentKey, Arc<TardisInstrumentMiniInfo>>,
    pub normalize_symbols: bool,
    pub book_snapshot_output: BookSnapshotOutput,
}

Provides a client for connecting to a Tardis Machine Server.

Fields

base_url: String

replay_signal: Arc<AtomicBool>

stream_signal: Arc<AtomicBool>

instruments: HashMap<TardisInstrumentKey, Arc<TardisInstrumentMiniInfo>>

normalize_symbols: bool

book_snapshot_output: BookSnapshotOutput

Implementations

impl TardisMachineClient

pub fn new( base_url: Option<&str>, normalize_symbols: bool, book_snapshot_output: BookSnapshotOutput, ) -> Result<Self>

Creates a new TardisMachineClient instance.

Errors

Returns an error if base_url is not provided and TARDIS_MACHINE_WS_URL env var is missing.

pub fn add_instrument_info(&mut self, info: TardisInstrumentMiniInfo)

pub fn is_closed(&self) -> bool

Returns true if close() has been called.

This checks that both replay and stream signals have been set, which only occurs when close() is explicitly called.

pub fn close(&mut self)

pub async fn replay( &self, options: Vec<ReplayNormalizedRequestOptions>, ) -> Result<impl Stream<Item = Result<Data, Error>>, Error>

Connects to the Tardis Machine replay WebSocket and yields parsed Data items.

Errors

Returns an error if the WebSocket connection cannot be established.

pub async fn stream( &self, instrument: TardisInstrumentMiniInfo, options: Vec<StreamNormalizedRequestOptions>, ) -> Result<impl Stream<Item = Result<Data, Error>>, Error>

Connects to the Tardis Machine stream WebSocket for a single instrument and yields parsed Data items.

Errors

Returns an error if the WebSocket connection cannot be established.

impl TardisMachineClient

pub fn py_is_closed(&self) -> bool

Trait Implementations

impl Clone for TardisMachineClient

fn clone(&self) -> TardisMachineClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TardisMachineClient

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

Formats the value using the given formatter.

impl<'py> IntoPyObject<'py> for TardisMachineClient

type Target = TardisMachineClient

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for TardisMachineClient

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 = /// Provides a client for connecting to a [Tardis Machine Server](https://docs.tardis.dev/api/tardis-machine).

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<TardisMachineClient>

This handles following two situations:

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

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for TardisMachineClient

const TEXT_SIGNATURE: &'static str = "(base_url=None, normalize_symbols=True, book_snapshot_output=\"deltas\")"

impl PyMethods<TardisMachineClient> for PyClassImplCollector<TardisMachineClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for TardisMachineClient

const NAME: &'static str = "TardisMachineClient"

Class name.

const MODULE: Option<&'static str>

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 TardisMachineClient

impl ExtractPyClassWithClone for TardisMachineClient