Struct HyperliquidTwapHistory 

pub struct HyperliquidTwapHistory {

    pub user: String,
    pub twap_id: Option<u64>,
    pub coin: String,
    pub instrument_id: Option<InstrumentId>,
    pub side: OrderSide,
    pub size: Decimal,
    pub executed_size: Decimal,
    pub executed_notional: Decimal,
    pub minutes: u32,
    pub reduce_only: bool,
    pub randomize: bool,
    pub status: HyperliquidTwapStatus,
    pub status_description: String,
    pub state_timestamp: UnixNanos,
    pub is_snapshot: bool,
    pub ts_event: UnixNanos,
    pub ts_init: UnixNanos,
}

One history row from the Hyperliquid userTwapHistory WebSocket channel.

Opt-in custom data (not part of default user execution subscriptions).

Fields

user: String

User address from the subscription envelope.

twap_id: Option<u64>

Venue TWAP id (twapId) when present on the row.

coin: String

Raw Hyperliquid coin symbol from state.coin.

instrument_id: Option<InstrumentId>

Resolved Nautilus instrument ID when the coin is known in cache.

side: OrderSide

TWAP order side.

size: Decimal

Total TWAP size.

executed_size: Decimal

Executed size so far.

executed_notional: Decimal

Executed notional so far.

minutes: u32

TWAP duration in minutes.

reduce_only: bool

Whether the TWAP is reduce-only.

randomize: bool

Whether slice timing is randomized.

status: HyperliquidTwapStatus

Venue TWAP status.

status_description: String

Venue status description.

state_timestamp: UnixNanos

state.timestamp converted to UNIX nanoseconds.

is_snapshot: bool

Whether this event belongs to a venue snapshot batch.

ts_event: UnixNanos

UNIX timestamp (nanoseconds) when the history row was produced (history.time).

ts_init: UnixNanos

UNIX timestamp (nanoseconds) when the instance was initialized.

Implementations

impl HyperliquidTwapHistory

pub fn new( user: String, twap_id: Option<u64>, coin: String, instrument_id: Option<InstrumentId>, side: OrderSide, size: Decimal, executed_size: Decimal, executed_notional: Decimal, minutes: u32, reduce_only: bool, randomize: bool, status: HyperliquidTwapStatus, status_description: String, state_timestamp: UnixNanos, is_snapshot: bool, ts_event: UnixNanos, ts_init: UnixNanos, ) -> Self

Constructor from all fields.

impl HyperliquidTwapHistory

pub fn repr(&self) -> String

Returns a string representation with ISO 8601 timestamps.

Trait Implementations

impl ArrowSchemaProvider for HyperliquidTwapHistory

fn get_schema(metadata: Option<HashMap<String, String>>) -> Schema

Returns the Arrow schema for this type with optional metadata.

fn get_schema_map() -> HashMap<String, String>

Returns a map of field names to their Arrow data types.

impl Clone for HyperliquidTwapHistory

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CustomDataSerialize for HyperliquidTwapHistory

fn schema(&self) -> Result<Schema>

Returns the Arrow schema for this custom data type.

fn encode_record_batch( &self, items: &[Arc<dyn CustomDataTrait>], ) -> Result<RecordBatch>

Encodes a batch of custom data items to an Arrow RecordBatch.

impl CustomDataTrait for HyperliquidTwapHistory

fn type_name(&self) -> &'static str

Returns the type name for the custom data.

fn type_name_static() -> &'static str

Returns the type name used in serialized form (e.g. in the "type" field).

fn as_any(&self) -> &dyn Any

Returns the data as a dyn Any for downcasting.

fn ts_event(&self) -> UnixNanos

Returns the event timestamp (when the data occurred).

fn to_json(&self) -> Result<String>

Serializes the custom data to a JSON string.

fn clone_arc(&self) -> Arc<dyn CustomDataTrait>

Returns a cloned Arc of the custom data.

fn eq_arc(&self, other: &dyn CustomDataTrait) -> bool

Returns whether the custom data is equal to another.

fn from_json(value: Value) -> Result<Arc<dyn CustomDataTrait>>

Deserializes from a JSON value into an Arc’d trait object.

fn to_pyobject(&self, py: Python<'_>) -> PyResult<Py<PyAny>>

Converts the custom data to a Python object.

fn to_json_py(&self) -> Result<String, Error>

Python-facing JSON serialization. Default implementation forwards to to_json. Override if a different behavior is needed for the Python API.

impl Debug for HyperliquidTwapHistory

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

Formats the value using the given formatter.

impl DecodeDataFromRecordBatch for HyperliquidTwapHistory

fn decode_data_batch( metadata: &HashMap<String, String>, record_batch: RecordBatch, ) -> Result<Vec<Data>, EncodingError>

Decodes a RecordBatch into raw Data values, using the provided metadata.

impl DerefToPyAny for HyperliquidTwapHistory

impl<'de> Deserialize<'de> for HyperliquidTwapHistory

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HyperliquidTwapHistory

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

Formats the value using the given formatter.

impl EncodeToRecordBatch for HyperliquidTwapHistory

fn encode_batch<T>( metadata: &HashMap<String, String>, data: &[T], ) -> Result<RecordBatch, ArrowError>

where T: Borrow<Self>,

Encodes a batch of values into an Arrow RecordBatch using the provided metadata.

fn metadata(&self) -> HashMap<String, String>

Returns the metadata for this data element.

fn chunk_metadata<T>(chunk: &[T]) -> HashMap<String, String>

where T: Borrow<Self>,

Returns the metadata selected for a chunk.

fn matches_chunk_metadata(&self, metadata: &HashMap<String, String>) -> bool

Returns whether this element is compatible with metadata selected for its chunk.

impl From<HyperliquidTwapHistory> for Data

fn from(value: HyperliquidTwapHistory) -> Self

Converts to this type from the input type.

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

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 HyperliquidTwapHistory

fn ts_init(&self) -> UnixNanos

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

impl<'py> IntoPyObject<'py> for HyperliquidTwapHistory

type Target = HyperliquidTwapHistory

The Python output type

type Output = Bound<'py, HyperliquidTwapHistory>

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>) -> PyResult<Bound<'py, Self>>

Performs the conversion.

impl PartialEq for HyperliquidTwapHistory

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

Equality operator ==.

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

Inequality operator !=.

impl PyClass for HyperliquidTwapHistory

const NAME: &str = "HyperliquidTwapHistory"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for HyperliquidTwapHistory

const RAW_DOC: &'static CStr = /// One history row from the Hyperliquid `userTwapHistory` WebSocket channel. /// /// Opt-in custom data (not part of default user execution subscriptions).

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

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

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 __traverse__(&self, visit: PyVisit<'_>) -> Result<(), PyTraverseError>

const MODULE: Option<&'static str> = None

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)]

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 HyperliquidTwapHistory

const TEXT_SIGNATURE: &'static str = "(user, twap_id, coin, instrument_id, side, size, executed_size, executed_notional, minutes, reduce_only, randomize, status, status_description, state_timestamp, is_snapshot, ts_event, ts_init)"

impl PyStubType for HyperliquidTwapHistory

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 HyperliquidTwapHistory

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 HyperliquidTwapHistory

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for HyperliquidTwapHistory

impl TryFrom<Data> for HyperliquidTwapHistory

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Data) -> Result<Self, Self::Error>

Performs the conversion.