Struct Bet 

pub struct Bet { /* private fields */ }

A bet in a betting market.

Implementations

impl Bet

pub fn new(price: Decimal, stake: Decimal, side: BetSide) -> Self

Creates a new Bet instance.

pub fn price(&self) -> Decimal

Returns the bet’s price.

pub fn stake(&self) -> Decimal

Returns the bet’s stake.

pub fn side(&self) -> BetSide

Returns the bet’s side.

pub fn from_stake_or_liability( price: Decimal, volume: Decimal, side: BetSide, ) -> Self

Creates a bet from a stake or liability depending on the bet side.

For BetSide::Back this calls Self::from_stake and for BetSide::Lay it calls Self::from_liability.

Panics

Panics if side is BetSide::Lay and Self::from_liability panics.

pub fn from_stake_or_liability_checked( price: Decimal, volume: Decimal, side: BetSide, ) -> Result<Self>

Creates a bet from a stake or liability depending on the bet side.

Errors

Returns an error if side is BetSide::Lay and Self::from_liability_checked fails.

pub fn from_stake(price: Decimal, stake: Decimal, side: BetSide) -> Self

Creates a bet from a given stake.

pub fn from_liability(price: Decimal, liability: Decimal, side: BetSide) -> Self

Creates a bet from a given liability.

Panics

Panics if the side is not BetSide::Lay, if price is not greater than 1, or if the stake calculation overflows.

pub fn from_liability_checked( price: Decimal, liability: Decimal, side: BetSide, ) -> Result<Self>

Creates a bet from a given liability.

Errors

Returns an error if the side is not BetSide::Lay, if price is not greater than 1, or if the stake calculation overflows.

pub fn exposure(&self) -> Decimal

Returns the bet’s exposure.

For BACK bets, exposure is positive; for LAY bets, it is negative.

Panics

Panics if the calculation overflows.

pub fn exposure_checked(&self) -> Result<Decimal>

Returns the bet’s exposure.

Errors

Returns an error if the calculation overflows.

pub fn liability(&self) -> Decimal

Returns the bet’s liability.

For BACK bets, liability equals the stake; for LAY bets, it is stake multiplied by (price - 1).

Panics

Panics if the calculation overflows.

pub fn liability_checked(&self) -> Result<Decimal>

Returns the bet’s liability.

Errors

Returns an error if the calculation overflows.

pub fn profit(&self) -> Decimal

Returns the bet’s profit.

For BACK bets, profit is stake * (price - 1); for LAY bets it equals the stake.

Panics

Panics if the calculation overflows.

pub fn profit_checked(&self) -> Result<Decimal>

Returns the bet’s profit.

Errors

Returns an error if the calculation overflows.

pub fn outcome_win_payoff(&self) -> Decimal

Returns the outcome win payoff.

For BACK bets this is the profit; for LAY bets it is the negative liability.

Panics

Panics if the calculation overflows.

pub fn outcome_win_payoff_checked(&self) -> Result<Decimal>

Returns the outcome win payoff.

Errors

Returns an error if the calculation overflows.

pub fn outcome_lose_payoff(&self) -> Decimal

Returns the outcome lose payoff.

For BACK bets this is the negative liability; for LAY bets it is the profit.

Panics

Panics if the calculation overflows.

pub fn outcome_lose_payoff_checked(&self) -> Result<Decimal>

Returns the outcome lose payoff.

Errors

Returns an error if the calculation overflows.

pub fn hedging_stake(&self, price: Decimal) -> Decimal

Returns the hedging stake given a new price.

Panics

Panics if price is zero, if this bet’s price is zero on the lay path, or if the calculation overflows.

pub fn hedging_stake_checked(&self, price: Decimal) -> Result<Decimal>

Returns the hedging stake given a new price.

Errors

Returns an error if price is zero, if this bet’s price is zero on the lay path, or if the calculation overflows.

pub fn hedging_bet(&self, price: Decimal) -> Self

Creates a hedging bet for a given price.

Panics

Panics if Self::hedging_stake panics.

pub fn hedging_bet_checked(&self, price: Decimal) -> Result<Self>

Creates a hedging bet for a given price.

Errors

Returns an error if Self::hedging_stake_checked fails.

Trait Implementations

impl Clone for Bet

fn clone(&self) -> Bet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Bet

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

Formats the value using the given formatter.

impl DerefToPyAny for Bet

impl Display for Bet

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

Formats the value using the given formatter.

impl Eq for Bet

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

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 Hash for Bet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'py> IntoPyObject<'py> for Bet

type Target = Bet

The Python output type

type Output = Bound<'py, <Bet 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 PartialEq for Bet

fn eq(&self, other: &Bet) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PyClass for Bet

const NAME: &str = "Bet"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for Bet

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 bet in a betting market.

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

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

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 Bet

const TEXT_SIGNATURE: &'static str = "(price, stake, side)"

impl PyStubType for Bet

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 Bet

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 StructuralPartialEq for Bet