Struct FundingRateUpdate 

#[repr(C)]
pub struct FundingRateUpdate {
    pub instrument_id: InstrumentId,
    pub rate: Decimal,
    pub interval: Option<u16>,
    pub next_funding_ns: Option<UnixNanos>,
    pub ts_event: UnixNanos,
    pub ts_init: UnixNanos,
}

Represents a funding rate update for perpetual swap instruments.

Fields

instrument_id: InstrumentId

The instrument ID for the funding rate.

rate: Decimal

The current funding rate.

interval: Option<u16>

Time interval (minutes) between funding payments.

next_funding_ns: Option<UnixNanos>

UNIX timestamp (nanoseconds) for the next funding time.

ts_event: UnixNanos

UNIX timestamp (nanoseconds) when the funding rate event occurred.

ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the instance was created.

Implementations

impl FundingRateUpdate

pub fn new( instrument_id: InstrumentId, rate: Decimal, interval: Option<u16>, next_funding_ns: Option<UnixNanos>, ts_event: UnixNanos, ts_init: UnixNanos, ) -> Self

Creates a new FundingRateUpdate instance.

pub fn get_metadata(instrument_id: &InstrumentId) -> HashMap<String, String>

Returns the metadata for the type, for use with serialization formats.

pub fn get_fields() -> IndexMap<String, String>

Returns the field map for the type, for use with Arrow schemas.

impl FundingRateUpdate

pub fn from_pyobject(obj: &Bound<'_, PyAny>) -> PyResult<Self>

Creates a new FundingRateUpdate from a Python object.

Errors

Returns a PyErr if extracting any attribute or converting types fails.

Trait Implementations

impl CatalogPathPrefix for FundingRateUpdate

fn path_prefix() -> &'static str

Returns the path prefix (directory name) for this data type.

impl Clone for FundingRateUpdate

fn clone(&self) -> FundingRateUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FundingRateUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FundingRateUpdate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FundingRateUpdate

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

Formats the value using the given formatter.

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

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 HasTsInit for FundingRateUpdate

fn ts_init(&self) -> UnixNanos

Returns the UNIX timestamp (nanoseconds) when the instance was created.

impl Hash for FundingRateUpdate

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 FundingRateUpdate

type Target = FundingRateUpdate

The Python output type

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

fn eq(&self, other: &Self) -> 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 FundingRateUpdate

const NAME: &str = "FundingRateUpdate"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for FundingRateUpdate

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 = /// Represents a funding rate update for perpetual swap instruments.

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

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

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 FundingRateUpdate

const TEXT_SIGNATURE: &'static str = "(instrument_id, rate, ts_event, ts_init, interval=None, next_funding_ns=None)"

impl PyStubType for FundingRateUpdate

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 FundingRateUpdate

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 Serializable for FundingRateUpdate

fn from_json_bytes(data: &[u8]) -> Result<Self, Error>

Deserialize an object from JSON encoded bytes.

fn to_json_bytes(&self) -> Result<Bytes, Error>

Serialize an object to JSON encoded bytes.

impl Serialize for FundingRateUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FundingRateUpdate

impl DerefToPyAny for FundingRateUpdate

impl Eq for FundingRateUpdate