Struct BetfairExecutionClientConfig 

pub struct BetfairExecutionClientConfig {

    pub account_id: AccountId,
    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 order_request_rate_per_second: u32,
    pub stream_host: Option<String>,
    pub stream_port: Option<u16>,
    pub stream_heartbeat_secs: Option<u64>,
    pub stream_heartbeat_timeout_secs: Option<u64>,
    pub stream_reconnect_delay_initial_ms: u64,
    pub stream_reconnect_delay_max_ms: u64,
    pub stream_use_tls: bool,
    pub stream_market_ids_filter: Option<Vec<String>>,
    pub ignore_external_orders: bool,
    pub calculate_account_state: bool,
    pub request_account_state_secs: u64,
    pub reconcile_market_ids_only: bool,
    pub reconcile_market_ids: Option<Vec<String>>,
    pub use_market_version: bool,
    pub stream_gap_recovery_lookback_mins: u64,
}

Configuration for the Betfair live execution client.

Fields

account_id: AccountId

Account ID for the client core.

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.

order_request_rate_per_second: u32

Order HTTP request rate limit per second.

stream_host: Option<String>

Optional override for stream host.

stream_port: Option<u16>

Optional override for stream port.

stream_heartbeat_secs: Option<u64>

Optional interval between outbound stream heartbeat messages in seconds.

stream_heartbeat_timeout_secs: Option<u64>

Optional dead-peer timeout override in seconds.

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_market_ids_filter: Option<Vec<String>>

Market IDs to filter on the order stream. When set, OCM updates for markets not in this list are skipped. None processes all markets.

ignore_external_orders: bool

When true, silently ignore orders from OCM that are not tracked in the local cache.

calculate_account_state: bool

Whether to poll account state periodically.

request_account_state_secs: u64

Interval in seconds between account state polls.

reconcile_market_ids_only: bool

When true, reconciliation only requests orders matching reconcile_market_ids.

reconcile_market_ids: Option<Vec<String>>

Market IDs to restrict reconciliation to.

use_market_version: bool

When true, attach the latest market version to placeOrders and replaceOrders requests.

stream_gap_recovery_lookback_mins: u64

Lookback window in minutes for the post-reconnect mass-status reconciliation that recovers fills which terminated during the disconnect gap. Should comfortably exceed the longest expected reconnect duration.

Implementations

impl BetfairExecutionClientConfig

pub fn builder() -> BetfairExecutionClientConfigBuilder

Create an instance of BetfairExecutionClientConfig using the builder syntax

impl BetfairExecutionClientConfig

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.

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

Returns the configured account currency.

Errors

Returns an error if the currency code is invalid.

pub fn stream_config(&self) -> BetfairStreamConfig

Returns the stream configuration.

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

Validates the configuration.

Errors

Returns an error if any configured value is invalid.

Trait Implementations

impl ClientConfig for BetfairExecutionClientConfig

fn as_any(&self) -> &dyn Any

Return the configuration as a trait object.

impl Clone for BetfairExecutionClientConfig

fn clone(&self) -> BetfairExecutionClientConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BetfairExecutionClientConfig

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

Formats the value using the given formatter.

impl Default for BetfairExecutionClientConfig

fn default() -> Self

Returns the “default value” for a type.

impl DerefToPyAny for BetfairExecutionClientConfig

impl<'de> Deserialize<'de> for BetfairExecutionClientConfig

where BetfairExecutionClientConfig: 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 BetfairExecutionClientConfig

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 BetfairExecutionClientConfig

type Target = BetfairExecutionClientConfig

The Python output type

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

const NAME: &str = "BetfairExecutionClientConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for BetfairExecutionClientConfig

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 Betfair live execution 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 = <<BetfairExecutionClientConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<BetfairExecutionClientConfig>

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

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 BetfairExecutionClientConfig

const TEXT_SIGNATURE: &'static str = "(account_id=None, account_currency=None, username=None, password=None, app_key=None, proxy_url=None, request_rate_per_second=5, order_request_rate_per_second=20, stream_host=None, stream_port=None, stream_heartbeat_secs=None, stream_heartbeat_timeout_secs=None, stream_reconnect_delay_initial_ms=2000, stream_reconnect_delay_max_ms=30000, stream_use_tls=True, stream_market_ids_filter=None, ignore_external_orders=False, calculate_account_state=True, request_account_state_secs=300, reconcile_market_ids_only=False, reconcile_market_ids=None, use_market_version=False, stream_gap_recovery_lookback_mins=10)"

impl PyStubType for BetfairExecutionClientConfig

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 BetfairExecutionClientConfig

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 BetfairExecutionClientConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.