OKXWebSocketClient

nautilus_okx::websocket::client

Struct OKXWebSocketClient 

Source 
pub struct OKXWebSocketClient { /* private fields */ }
Expand description

Provides a WebSocket client for connecting to OKX.

Implementations§

Source§

impl OKXWebSocketClient

Source

pub fn new( url: Option<String>, api_key: Option<String>, api_secret: Option<String>, api_passphrase: Option<String>, account_id: Option<AccountId>, heartbeat: Option<u64>, ) -> Result<Self>

Creates a new OKXWebSocketClient instance.

§Errors

Returns an error if the request fails.

Source

pub fn with_credentials( url: Option<String>, api_key: Option<String>, api_secret: Option<String>, api_passphrase: Option<String>, account_id: Option<AccountId>, heartbeat: Option<u64>, ) -> Result<Self>

Creates a new OKXWebSocketClient instance.

§Errors

Returns an error if credential values cannot be loaded or if the client fails to initialize.

Source

pub fn from_env() -> Result<Self>

Creates a new authenticated OKXWebSocketClient using environment variables.

§Errors

Returns an error if required environment variables are missing or if the client fails to initialize.

Source

pub fn cancel_all_requests(&self)

Cancel all pending WebSocket requests.

Source

pub fn cancellation_token(&self) -> &CancellationToken

Get the cancellation token for this client.

Source

pub fn url(&self) -> &str

Returns the websocket url being used by the client.

Source

pub fn api_key(&self) -> Option<&str>

Returns the public API key being used by the client.

Source

pub fn is_active(&self) -> bool

Get a read lock on the inner client Returns a value indicating whether the client is active.

Source

pub fn is_closed(&self) -> bool

Returns a value indicating whether the client is closed.

Source

pub fn initialize_instruments_cache(&mut self, instruments: Vec<InstrumentAny>)

Initialize the instruments cache with the given instruments.

Source

pub fn set_vip_level(&self, vip_level: OKXVipLevel)

Sets the VIP level for this client.

The VIP level determines which WebSocket channels are available.

Source

pub fn vip_level(&self) -> OKXVipLevel

Gets the current VIP level.

Source

pub async fn connect(&mut self) -> Result<()>

Connect to the OKX WebSocket server.

§Errors

Returns an error if the connection process fails.

§Panics

Panics if subscription arguments fail to serialize to JSON.

Source

pub fn stream(&mut self) -> impl Stream<Item = NautilusWsMessage> + 'static

Provides the internal data stream as a channel-based stream.

§Panics

This function panics if:

  • The websocket is not connected.
  • stream_data has already been called somewhere else (stream receiver is then taken).
Source

pub async fn wait_until_active( &self, timeout_secs: f64, ) -> Result<(), OKXWsError>

Wait until the WebSocket connection is active.

§Errors

Returns an error if the connection times out.

Source

pub async fn close(&mut self) -> Result<(), Error>

Closes the client.

§Errors

Returns an error if disconnecting the websocket or cleaning up the client fails.

Source

pub fn get_subscriptions( &self, instrument_id: InstrumentId, ) -> Vec<OKXWsChannel>

Get active subscriptions for a specific instrument.

Source

pub async fn unsubscribe_all(&self) -> Result<(), OKXWsError>

Unsubscribes from all active subscriptions in batched messages.

Collects all confirmed subscriptions and sends unsubscribe requests in batches, which is significantly more efficient than individual unsubscribes during disconnect.

§Errors

Returns an error if the unsubscribe request fails to send.

Source

pub async fn subscribe_instruments( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Subscribes to instrument updates for a specific instrument type.

Provides updates when instrument specifications change.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#public-data-websocket-instruments-channel.

Source

pub async fn subscribe_instrument( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to instrument updates for a specific instrument.

Provides updates when instrument specifications change.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#public-data-websocket-instruments-channel.

Source

pub async fn subscribe_book(&self, instrument_id: InstrumentId) -> Result<()>

Subscribes to order book data for an instrument.

This is a convenience method that calls Self::subscribe_book_with_depth with depth 0, which automatically selects the appropriate channel based on VIP level.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn subscribe_book_depth5( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to 5-level order book snapshot data for an instrument.

Updates every 100ms when there are changes.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-5-depth-channel.

Source

pub async fn subscribe_book50_l2_tbt( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to 50-level tick-by-tick order book data for an instrument.

Provides real-time updates whenever order book changes.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-50-depth-tbt-channel.

Source

pub async fn subscribe_book_l2_tbt( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to tick-by-tick full depth (400 levels) order book data for an instrument.

Provides real-time updates with all depth levels whenever order book changes.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-order-book-400-depth-tbt-channel.

Source

pub async fn subscribe_book_with_depth( &self, instrument_id: InstrumentId, depth: u16, ) -> Result<()>

Subscribes to order book data with automatic channel selection based on VIP level and depth.

Selects the optimal channel based on user’s VIP tier and requested depth:

  • depth 50: Requires VIP4+, subscribes to books50-l2-tbt
  • depth 0 or 400:
    • VIP5+: subscribes to books-l2-tbt (400 depth, fastest)
    • Below VIP5: subscribes to books (standard depth)
§Errors

Returns an error if:

  • Subscription request fails
  • depth is 50 but VIP level is below 4
Source

pub async fn subscribe_quotes( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to best bid/ask quote data for an instrument.

Provides tick-by-tick updates of the best bid and ask prices using the bbo-tbt channel. Supports all instrument types: SPOT, MARGIN, SWAP, FUTURES, OPTION.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-best-bid-offer-channel.

Source

pub async fn subscribe_trades( &self, instrument_id: InstrumentId, aggregated: bool, ) -> Result<(), OKXWsError>

Subscribes to trade data for an instrument.

When aggregated is false, subscribes to the trades channel (per-match updates). When aggregated is true, subscribes to the trades-all channel (aggregated updates).

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-trades-channel. https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-all-trades-channel.

Source

pub async fn subscribe_ticker( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to 24hr rolling ticker data for an instrument.

Updates every 100ms with trading statistics.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-tickers-channel.

Source

pub async fn subscribe_mark_prices( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to mark price data for derivatives instruments.

Updates every 200ms for perpetual swaps, or at settlement for futures.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#public-data-websocket-mark-price-channel.

Source

pub async fn subscribe_index_prices( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to index price data for an instrument.

Updates every second with the underlying index price.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#public-data-websocket-index-tickers-channel.

Source

pub async fn subscribe_funding_rates( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Subscribes to funding rate data for perpetual swap instruments.

Updates when funding rate changes or at funding intervals.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#public-data-websocket-funding-rate-channel.

Source

pub async fn subscribe_bars(&self, bar_type: BarType) -> Result<(), OKXWsError>

Subscribes to candlestick/bar data for an instrument.

Supports various time intervals from 1s to 3M.

§Errors

Returns an error if the subscription request fails.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-market-data-ws-candlesticks-channel.

Source

pub async fn unsubscribe_instruments( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Unsubscribes from instrument updates for a specific instrument type.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_instrument( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from instrument updates for a specific instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_book( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from full order book data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_book_depth5( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from 5-level order book snapshot data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_book50_l2_tbt( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from 50-level tick-by-tick order book data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_book_l2_tbt( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from tick-by-tick full depth order book data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_quotes( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from best bid/ask quote data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_ticker( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from 24hr rolling ticker data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_mark_prices( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from mark price data for a derivatives instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_index_prices( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from index price data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_funding_rates( &self, instrument_id: InstrumentId, ) -> Result<(), OKXWsError>

Unsubscribe from funding rate data for a perpetual swap instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_trades( &self, instrument_id: InstrumentId, aggregated: bool, ) -> Result<(), OKXWsError>

Unsubscribe from trade data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_bars( &self, bar_type: BarType, ) -> Result<(), OKXWsError>

Unsubscribe from candlestick/bar data for an instrument.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn subscribe_orders( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Subscribes to order updates for the given instrument type.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_orders( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Unsubscribes from order updates for the given instrument type.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn subscribe_orders_algo( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Subscribes to algo order updates for the given instrument type.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_orders_algo( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Unsubscribes from algo order updates for the given instrument type.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn subscribe_fills( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Subscribes to fill updates for the given instrument type.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_fills( &self, instrument_type: OKXInstrumentType, ) -> Result<(), OKXWsError>

Unsubscribes from fill updates for the given instrument type.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn subscribe_account(&self) -> Result<(), OKXWsError>

Subscribes to account balance updates.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn unsubscribe_account(&self) -> Result<(), OKXWsError>

Unsubscribes from account balance updates.

§Errors

Returns an error if the subscription request fails.

Source

pub async fn submit_order( &self, trader_id: TraderId, strategy_id: StrategyId, instrument_id: InstrumentId, td_mode: OKXTradeMode, client_order_id: ClientOrderId, order_side: OrderSide, order_type: OrderType, quantity: Quantity, time_in_force: Option<TimeInForce>, price: Option<Price>, trigger_price: Option<Price>, post_only: Option<bool>, reduce_only: Option<bool>, quote_quantity: Option<bool>, position_side: Option<PositionSide>, ) -> Result<(), OKXWsError>

Submits an order, automatically routing conditional orders to the algo endpoint.

§Errors

Returns an error if the order parameters are invalid or if the request cannot be sent to the websocket client.

§References
Source

pub async fn cancel_order( &self, trader_id: TraderId, strategy_id: StrategyId, instrument_id: InstrumentId, client_order_id: Option<ClientOrderId>, venue_order_id: Option<VenueOrderId>, ) -> Result<(), OKXWsError>

Cancels an existing order.

§Errors

Returns an error if the cancel parameters are invalid or if the cancellation request fails to send.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-cancel-order.

Source

pub async fn modify_order( &self, trader_id: TraderId, strategy_id: StrategyId, instrument_id: InstrumentId, client_order_id: Option<ClientOrderId>, price: Option<Price>, quantity: Option<Quantity>, venue_order_id: Option<VenueOrderId>, ) -> Result<(), OKXWsError>

Modifies an existing order.

§Errors

Returns an error if the amend parameters are invalid or if the websocket request fails to send.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-trade-ws-amend-order.

Source

pub async fn batch_submit_orders( &self, orders: Vec<(OKXInstrumentType, InstrumentId, OKXTradeMode, ClientOrderId, OrderSide, Option<PositionSide>, OrderType, Quantity, Option<Price>, Option<Price>, Option<bool>, Option<bool>)>, ) -> Result<(), OKXWsError>

Submits multiple orders.

§Errors

Returns an error if any batch order parameters are invalid or if the batch request fails to send.

Source

pub async fn batch_cancel_orders( &self, orders: Vec<(InstrumentId, Option<ClientOrderId>, Option<VenueOrderId>)>, ) -> Result<(), OKXWsError>

Cancels multiple orders.

Supports up to 20 orders per batch.

§Errors

Returns an error if cancel parameters are invalid or if the batch request fails to send.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-websocket-batch-cancel-orders

Source

pub async fn mass_cancel_orders( &self, inst_id: InstrumentId, ) -> Result<(), OKXWsError>

Mass cancels all orders for a given instrument via WebSocket.

§Errors

Returns an error if instrument metadata cannot be resolved or if the cancel request fails to send.

§Parameters
  • inst_id: The instrument ID. The instrument type will be automatically determined from the symbol.
§References

https://www.okx.com/docs-v5/en/#order-book-trading-websocket-mass-cancel-order Helper function to determine instrument type and family from symbol using instruments cache.

Source

pub async fn batch_modify_orders( &self, orders: Vec<(OKXInstrumentType, InstrumentId, ClientOrderId, ClientOrderId, Option<Price>, Option<Quantity>)>, ) -> Result<(), OKXWsError>

Modifies multiple orders via WebSocket using Nautilus domain types.

§Errors

Returns an error if amend parameters are invalid or if the batch request fails to send.

Source

pub async fn submit_algo_order( &self, trader_id: TraderId, strategy_id: StrategyId, instrument_id: InstrumentId, td_mode: OKXTradeMode, client_order_id: ClientOrderId, order_side: OrderSide, order_type: OrderType, quantity: Quantity, trigger_price: Price, trigger_type: Option<TriggerType>, limit_price: Option<Price>, reduce_only: Option<bool>, ) -> Result<(), OKXWsError>

Submits an algo order (conditional/stop order).

§Errors

Returns an error if the order parameters are invalid or if the request cannot be sent.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-place-algo-order

Source

pub async fn cancel_algo_order( &self, trader_id: TraderId, strategy_id: StrategyId, instrument_id: InstrumentId, client_order_id: Option<ClientOrderId>, algo_order_id: Option<String>, ) -> Result<(), OKXWsError>

Cancels an algo order.

§Errors

Returns an error if cancel parameters are invalid or if the request fails to send.

§References

https://www.okx.com/docs-v5/en/#order-book-trading-algo-trading-post-cancel-algo-order

Source§

impl OKXWebSocketClient

Source

pub fn py_url(&self) -> &str

Source

pub fn py_api_key(&self) -> Option<&str>

Source

pub fn py_cancel_all_requests(&self)

Trait Implementations§

Source§

impl Clone for OKXWebSocketClient

Source§

fn clone(&self) -> OKXWebSocketClient

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OKXWebSocketClient

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for OKXWebSocketClient

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'py> IntoPyObject<'py> for OKXWebSocketClient

Source§

type Target = OKXWebSocketClient

The Python output type
Source§

type Output = Bound<'py, <OKXWebSocketClient as IntoPyObject<'py>>::Target>

The smart pointer type to use. Read more
Source§

type Error = PyErr

The type returned in the event of a conversion error.
Source§

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.
Source§

impl PyClass for OKXWebSocketClient

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for OKXWebSocketClient

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = /// Provides a WebSocket client for connecting to [OKX](https://okx.com).

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<OKXWebSocketClient>

This handles following two situations: Read more
Source§

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable
Source§

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.
Source§

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.
Source§

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.
Source§

fn items_iter() -> PyClassItemsIter

Source§

fn lazy_type_object() -> &'static LazyTypeObject<Self>

§

fn dict_offset() -> Option<isize>

§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for OKXWebSocketClient

Source§

const TEXT_SIGNATURE: &'static str = "(url=None, api_key=None, api_secret=None, api_passphrase=None, account_id=None, heartbeat=None)"

Source§

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder OKXWebSocketClient

Source§

type Holder = Option<PyClassGuard<'a, OKXWebSocketClient>>

Source§

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

Source§

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut OKXWebSocketClient

Source§

type Holder = Option<PyClassGuardMut<'a, OKXWebSocketClient>>

Source§

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

Source§

impl PyMethods<OKXWebSocketClient> for PyClassImplCollector<OKXWebSocketClient>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for OKXWebSocketClient

Source§

const NAME: &'static str = "OKXWebSocketClient"

Class name.
Source§

const MODULE: Option<&'static str>

Module name, if any.
Source§

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.
Source§

impl DerefToPyAny for OKXWebSocketClient

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromPyObject<'_> for T
where T: PyClass + Clone,

§

fn extract_bound(obj: &Bound<'_, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more
§

impl<'py, T> FromPyObjectBound<'_, 'py> for T
where T: FromPyObject<'py>,

§

fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
§

impl<'py, T> IntoPyObjectNautilusExt<'py> for T
where T: IntoPyObjectExt<'py>,

§

fn into_py_any_unwrap(self, py: Python<'py>) -> Py<PyAny>

Convert self into a [Py<PyAny>] while panicking if the conversion fails. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

§

const NAME: &'static str = <T as PyTypeInfo>::NAME

Name of self. This is used in error messages, for example.
§

fn type_check(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Ungil for T
where T: Send,