Skip to main content

BetfairDataConfig

Struct BetfairDataConfig 

Source
pub struct BetfairDataConfig {
Show 25 fields pub account_currency: String, pub username: Option<String>, pub password: Option<String>, pub app_key: Option<String>, pub proxy_url: Option<String>, pub request_rate_per_second: u32, pub default_min_notional: Option<f64>, pub event_type_ids: Option<Vec<String>>, pub event_type_names: Option<Vec<String>>, pub event_ids: Option<Vec<String>>, pub country_codes: Option<Vec<String>>, pub market_types: Option<Vec<String>>, pub market_ids: Option<Vec<String>>, pub min_market_start_time: Option<String>, pub max_market_start_time: Option<String>, pub stream_host: Option<String>, pub stream_port: Option<u16>, pub stream_heartbeat_ms: u64, pub stream_idle_timeout_ms: u64, pub stream_reconnect_delay_initial_ms: u64, pub stream_reconnect_delay_max_ms: u64, pub stream_use_tls: bool, pub stream_conflate_ms: Option<u64>, pub subscription_delay_secs: u64, pub subscribe_race_data: bool,
}
Expand description

Configuration for the Betfair live data client.

Fields§

§account_currency: String

Account currency code.

§username: Option<String>

Optional Betfair username.

§password: Option<String>

Optional Betfair password.

§app_key: Option<String>

Optional Betfair application key.

§proxy_url: Option<String>

Optional proxy URL for HTTP requests.

§request_rate_per_second: u32

General HTTP request rate limit per second.

§default_min_notional: Option<f64>

Optional default minimum notional in account_currency.

§event_type_ids: Option<Vec<String>>

Optional event type ID filter.

§event_type_names: Option<Vec<String>>

Optional event type name filter.

§event_ids: Option<Vec<String>>

Optional event ID filter.

§country_codes: Option<Vec<String>>

Optional country code filter.

§market_types: Option<Vec<String>>

Optional market type filter.

§market_ids: Option<Vec<String>>

Optional market ID filter.

§min_market_start_time: Option<String>

Optional lower bound for market start time.

§max_market_start_time: Option<String>

Optional upper bound for market start time.

§stream_host: Option<String>

Optional override for stream host.

§stream_port: Option<u16>

Optional override for stream port.

§stream_heartbeat_ms: u64

Interval between stream heartbeat messages in milliseconds.

§stream_idle_timeout_ms: u64

Stream idle timeout in milliseconds.

§stream_reconnect_delay_initial_ms: u64

Initial reconnection backoff in milliseconds.

§stream_reconnect_delay_max_ms: u64

Maximum reconnection backoff in milliseconds.

§stream_use_tls: bool

Whether to use TLS for the stream connection.

§stream_conflate_ms: Option<u64>

Stream conflation setting in milliseconds. When set, Betfair batches stream updates for this interval. None uses Betfair defaults.

§subscription_delay_secs: u64

Delay in seconds before sending the initial subscription message after connecting.

§subscribe_race_data: bool

Subscribe to the race stream for Total Performance Data (TPD).

Implementations§

Source§

impl BetfairDataConfig

Source

pub fn builder() -> BetfairDataConfigBuilder

Create an instance of BetfairDataConfig using the builder syntax

Source§

impl BetfairDataConfig

Source

pub fn credential(&self) -> Result<BetfairCredential>

Returns the configured credentials or resolves them from the environment.

§Errors

Returns an error if credentials are incomplete or unavailable.

Source

pub fn currency(&self) -> Result<Currency>

Returns the configured account currency.

§Errors

Returns an error if the currency code is invalid.

Source

pub fn min_notional(&self) -> Result<Option<Money>>

Returns the default instrument minimum notional.

§Errors

Returns an error if the account currency code is invalid.

Source

pub fn navigation_filter(&self) -> NavigationFilter

Returns the navigation filter for instrument loading.

Source

pub fn stream_config(&self) -> BetfairStreamConfig

Returns the stream configuration.

Source

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

Validates the configuration.

§Errors

Returns an error if any configured value is invalid.

Trait Implementations§

Source§

impl ClientConfig for BetfairDataConfig

Source§

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.
Source§

impl Clone for BetfairDataConfig

Source§

fn clone(&self) -> BetfairDataConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BetfairDataConfig

Source§

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

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

impl Default for BetfairDataConfig

Source§

fn default() -> Self

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

impl<'a, 'py> FromPyObject<'a, 'py> for BetfairDataConfig
where Self: Clone,

Source§

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error. Read more
Source§

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

Extracts Self from the bound smart pointer obj. Read more
Source§

impl<'py> IntoPyObject<'py> for BetfairDataConfig

Source§

type Target = BetfairDataConfig

The Python output type
Source§

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

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl PyClass for BetfairDataConfig

Source§

const NAME: &str = "BetfairDataConfig"

Name of the class. Read more
Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for BetfairDataConfig

Source§

const MODULE: Option<&str>

Module which the class will be associated with. Read more
Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

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

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

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

Description of how this class is laid out in memory
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = NoopThreadChecker

This handles following two situations: Read more
Source§

type Inventory = Pyo3MethodsInventoryForBetfairDataConfig

Source§

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

Immutable or mutable
Source§

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

Source§

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
Source§

impl PyClassNewTextSignature for BetfairDataConfig

Source§

const TEXT_SIGNATURE: &'static str = "(account_currency=None, username=None, password=None, app_key=None, proxy_url=None, request_rate_per_second=5, default_min_notional=None, event_type_ids=None, event_type_names=None, event_ids=None, country_codes=None, market_types=None, market_ids=None, min_market_start_time=None, max_market_start_time=None, stream_host=None, stream_port=None, stream_heartbeat_ms=5000, stream_idle_timeout_ms=60000, stream_reconnect_delay_initial_ms=2000, stream_reconnect_delay_max_ms=30000, stream_use_tls=True, stream_conflate_ms=None, subscription_delay_secs=None, subscribe_race_data=False)"

Source§

impl PyStubType for BetfairDataConfig

Source§

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. Read more
Source§

impl PyTypeInfo for BetfairDataConfig

Source§

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.
Source§

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.
Source§

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.
Source§

impl DerefToPyAny for BetfairDataConfig

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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

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

Converts self into a Python object. Read more
§

impl<'py, T> IntoPyObjectNautilusExt<'py> for T
where T: IntoPyObjectExt<'py>,

§

fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>

Convert self into a [Py<PyAny>] while panicking if the conversion fails. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0:

Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.

Name of self. This is used in error messages, for example.
§

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

Checks if object is an instance of Self, which may include a subtype. Read more
§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

impl<'py, T> FromPyObjectOwned<'py> for T
where T: for<'a> FromPyObject<'a, 'py>,

§

impl<T> Ungil for T
where T: Send,