Struct PoolState 

pub struct PoolState {
    pub current_tick: i32,
    pub price_sqrt_ratio_x96: U160,
    pub liquidity: u128,
    pub protocol_fees_token0: U256,
    pub protocol_fees_token1: U256,
    pub fee_protocol: u8,
    pub fee_growth_global_0: U256,
    pub fee_growth_global_1: U256,
}

Global state snapshot of a liquidity pool at a specific point in time.

PoolState encapsulates the core global variables that define a UniswapV3-style AMM pool’s current state. This includes the current price position, cumulative deposit/withdrawal flows, and protocol fee configuration.

Fields

current_tick: i32

Current tick position of the pool price.

price_sqrt_ratio_x96: U160

Current sqrt price ratio as Q64.96 fixed point number.

liquidity: u128

Current active liquidity in the pool.

protocol_fees_token0: U256

Accumulated protocol fees in token0 units.

protocol_fees_token1: U256

Accumulated protocol fees in token1 units.

fee_protocol: u8

Protocol fee packed: lower 4 bits for token0, upper 4 bits for token1.

fee_growth_global_0: U256

Global fee growth for token0 as Q128.128 fixed-point number.

fee_growth_global_1: U256

Global fee growth for token1 as Q128.128 fixed-point number.

Implementations

impl PoolState

pub fn new( protocol_fees_token0: U256, protocol_fees_token1: U256, fee_protocol: u8, ) -> Self

Creates a new PoolState with the specified parameters.

Trait Implementations

impl Clone for PoolState

fn clone(&self) -> PoolState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PoolState

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

Formats the value using the given formatter.

impl Default for PoolState

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PoolState

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 PoolState

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 PoolState

type Target = PoolState

The Python output type

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for PoolState

const NAME: &str = "PoolState"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PoolState

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 = /// Global state snapshot of a liquidity pool at a specific point in time. /// /// `PoolState` encapsulates the core global variables that define a UniswapV3-style /// AMM pool's current state. This includes the current price position, cumulative /// deposit/withdrawal flows, and protocol fee configuration.

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

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

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 PyStubType for PoolState

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 PoolState

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 PoolState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for PoolState

impl StructuralPartialEq for PoolState