ExchangeCapabilities

Struct ExchangeCapabilities 

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

Exchange capabilities configuration

This struct provides a high-level API for working with exchange capabilities, maintaining backward compatibility with the original boolean-field design while using efficient bitflags internally.

§Example

use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::public_only();
assert!(caps.has("fetchTicker"));
assert!(!caps.has("createOrder"));

let caps = ExchangeCapabilities::all();
assert!(caps.fetch_ticker());
assert!(caps.create_order());

Implementations§

Source§

impl ExchangeCapabilities

Source

pub const fn none() -> ExchangeCapabilities

Create with no capabilities enabled

Source

pub const fn all() -> ExchangeCapabilities

Create capabilities with all features enabled

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::all();
assert!(caps.fetch_ticker());
assert!(caps.create_order());
assert!(caps.websocket());
Source

pub const fn public_only() -> ExchangeCapabilities

Create capabilities for public API only (no authentication required)

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::public_only();
assert!(caps.fetch_ticker());
assert!(!caps.create_order());
Source

pub const fn from_capabilities(caps: Capabilities) -> ExchangeCapabilities

Create from raw Capabilities bitflags

Source

pub const fn as_capabilities(&self) -> Capabilities

Get the underlying Capabilities bitflags

Source

pub fn has(&self, capability: &str) -> bool

Check if a capability is supported by name

This method allows checking capabilities using CCXT-style camelCase names.

§Arguments
  • capability - The capability name in camelCase format
§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::all();
assert!(caps.has("fetchTicker"));
assert!(caps.has("createOrder"));
assert!(!caps.has("unknownCapability"));
Source

pub fn supported_capabilities(&self) -> Vec<&'static str>

Get a list of all supported capability names

Source

pub fn count(&self) -> u32

Count the number of enabled capabilities

Source

pub const fn fetch_markets(&self) -> bool

Can fetch market definitions

Source

pub const fn fetch_currencies(&self) -> bool

Can fetch currency definitions

Source

pub const fn fetch_ticker(&self) -> bool

Can fetch single ticker

Source

pub const fn fetch_tickers(&self) -> bool

Can fetch multiple tickers

Source

pub const fn fetch_order_book(&self) -> bool

Can fetch order book

Source

pub const fn fetch_trades(&self) -> bool

Can fetch public trades

Source

pub const fn fetch_ohlcv(&self) -> bool

Can fetch OHLCV candlestick data

Source

pub const fn fetch_status(&self) -> bool

Can fetch exchange status

Source

pub const fn fetch_time(&self) -> bool

Can fetch server time

Source

pub const fn create_order(&self) -> bool

Can create orders

Source

pub const fn create_market_order(&self) -> bool

Can create market orders

Source

pub const fn create_limit_order(&self) -> bool

Can create limit orders

Source

pub const fn cancel_order(&self) -> bool

Can cancel orders

Source

pub const fn cancel_all_orders(&self) -> bool

Can cancel all orders

Source

pub const fn edit_order(&self) -> bool

Can edit/modify orders

Source

pub const fn fetch_order(&self) -> bool

Can fetch single order

Source

pub const fn fetch_orders(&self) -> bool

Can fetch all orders

Source

pub const fn fetch_open_orders(&self) -> bool

Can fetch open orders

Source

pub const fn fetch_closed_orders(&self) -> bool

Can fetch closed orders

Source

pub const fn fetch_canceled_orders(&self) -> bool

Can fetch canceled orders

Source

pub const fn fetch_balance(&self) -> bool

Can fetch account balance

Source

pub const fn fetch_my_trades(&self) -> bool

Can fetch user’s trade history

Source

pub const fn fetch_deposits(&self) -> bool

Can fetch deposit history

Source

pub const fn fetch_withdrawals(&self) -> bool

Can fetch withdrawal history

Source

pub const fn fetch_transactions(&self) -> bool

Can fetch transaction history

Source

pub const fn fetch_ledger(&self) -> bool

Can fetch ledger entries

Source

pub const fn fetch_deposit_address(&self) -> bool

Can fetch deposit address

Source

pub const fn create_deposit_address(&self) -> bool

Can create deposit address

Source

pub const fn withdraw(&self) -> bool

Can withdraw funds

Source

pub const fn transfer(&self) -> bool

Can transfer between accounts

Source

pub const fn fetch_borrow_rate(&self) -> bool

Can fetch borrow rate

Source

pub const fn fetch_borrow_rates(&self) -> bool

Can fetch multiple borrow rates

Source

pub const fn fetch_funding_rate(&self) -> bool

Can fetch funding rate

Source

pub const fn fetch_funding_rates(&self) -> bool

Can fetch multiple funding rates

Source

pub const fn fetch_positions(&self) -> bool

Can fetch positions

Source

pub const fn set_leverage(&self) -> bool

Can set leverage

Source

pub const fn set_margin_mode(&self) -> bool

Can set margin mode

Source

pub const fn websocket(&self) -> bool

WebSocket support available

Source

pub const fn watch_ticker(&self) -> bool

Can watch ticker updates

Source

pub const fn watch_tickers(&self) -> bool

Can watch multiple ticker updates

Source

pub const fn watch_order_book(&self) -> bool

Can watch order book updates

Source

pub const fn watch_trades(&self) -> bool

Can watch trade updates

Source

pub const fn watch_ohlcv(&self) -> bool

Can watch OHLCV updates

Source

pub const fn watch_balance(&self) -> bool

Can watch balance updates

Source

pub const fn watch_orders(&self) -> bool

Can watch order updates

Source

pub const fn watch_my_trades(&self) -> bool

Can watch user trade updates

Source

pub fn builder() -> ExchangeCapabilitiesBuilder

Create a builder for ExchangeCapabilities

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::builder()
    .market_data()
    .trading()
    .websocket()
    .build();
assert!(caps.fetch_ticker());
assert!(caps.create_order());
assert!(caps.websocket());
Source§

impl ExchangeCapabilities

Source

pub const fn spot_exchange() -> ExchangeCapabilities

Create capabilities for a typical spot exchange

Includes: market data, trading, account, and basic WebSocket

Source

pub const fn futures_exchange() -> ExchangeCapabilities

Create capabilities for a typical futures exchange

Includes: spot capabilities + margin trading

Create capabilities for a full-featured exchange (like Binance)

Includes: all capabilities

Source§

impl ExchangeCapabilities

Source

pub const fn supports_market_data(&self) -> bool

Check if the exchange supports the MarketData trait.

Returns true if the exchange has the minimum capabilities required to implement the MarketData trait (fetch_markets and fetch_ticker).

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::public_only();
assert!(caps.supports_market_data());

let caps = ExchangeCapabilities::none();
assert!(!caps.supports_market_data());
Source

pub const fn supports_trading(&self) -> bool

Check if the exchange supports the Trading trait.

Returns true if the exchange has the minimum capabilities required to implement the Trading trait (create_order and cancel_order).

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::all();
assert!(caps.supports_trading());

let caps = ExchangeCapabilities::public_only();
assert!(!caps.supports_trading());
Source

pub const fn supports_account(&self) -> bool

Check if the exchange supports the Account trait.

Returns true if the exchange has the minimum capabilities required to implement the Account trait (fetch_balance).

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::all();
assert!(caps.supports_account());

let caps = ExchangeCapabilities::public_only();
assert!(!caps.supports_account());
Source

pub const fn supports_margin(&self) -> bool

Check if the exchange supports the Margin trait.

Returns true if the exchange has the minimum capabilities required to implement the Margin trait (fetch_positions).

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::futures_exchange();
assert!(caps.supports_margin());

let caps = ExchangeCapabilities::spot_exchange();
assert!(!caps.supports_margin());
Source

pub const fn supports_funding(&self) -> bool

Check if the exchange supports the Funding trait.

Returns true if the exchange has the minimum capabilities required to implement the Funding trait (fetch_deposit_address).

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::all();
assert!(caps.supports_funding());

let caps = ExchangeCapabilities::public_only();
assert!(!caps.supports_funding());
Source

pub const fn supports_websocket(&self) -> bool

Check if the exchange supports WebSocket.

Returns true if the exchange has the base WebSocket capability.

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::all();
assert!(caps.supports_websocket());

let caps = ExchangeCapabilities::public_only();
assert!(!caps.supports_websocket());
Source

pub const fn supports_full_exchange(&self) -> bool

Check if the exchange supports all traits (FullExchange).

Returns true if the exchange has the minimum capabilities required to implement all traits: MarketData, Trading, Account, Margin, and Funding.

§Example
use ccxt_core::capability::ExchangeCapabilities;

let caps = ExchangeCapabilities::all();
assert!(caps.supports_full_exchange());

let caps = ExchangeCapabilities::spot_exchange();
assert!(!caps.supports_full_exchange());
Source

pub const fn supports_trait(&self, category: TraitCategory) -> bool

Check if the exchange supports a specific trait category.

§Arguments
  • category - The trait category to check
§Example
use ccxt_core::capability::{ExchangeCapabilities, TraitCategory};

let caps = ExchangeCapabilities::all();
assert!(caps.supports_trait(TraitCategory::MarketData));
assert!(caps.supports_trait(TraitCategory::Trading));
Source

pub fn supported_traits(&self) -> Vec<TraitCategory>

Get a list of supported trait categories.

Returns a vector of trait categories that this exchange supports based on its capabilities.

§Example
use ccxt_core::capability::{ExchangeCapabilities, TraitCategory};

let caps = ExchangeCapabilities::public_only();
let traits = caps.supported_traits();
assert!(traits.contains(&TraitCategory::PublicExchange));
assert!(traits.contains(&TraitCategory::MarketData));
assert!(!traits.contains(&TraitCategory::Trading));
Source

pub const fn capabilities_for_trait( &self, category: TraitCategory, ) -> Capabilities

Get capabilities for a specific trait category.

Returns the capabilities that are enabled for the specified trait category.

§Arguments
  • category - The trait category to get capabilities for
§Example
use ccxt_core::capability::{ExchangeCapabilities, TraitCategory, Capabilities};

let caps = ExchangeCapabilities::all();
let market_caps = caps.capabilities_for_trait(TraitCategory::MarketData);
assert!(market_caps.contains(Capabilities::FETCH_TICKER));
Source

pub const fn trait_for_capability(capability: Capability) -> TraitCategory

Get the trait category for a specific capability.

§Arguments
  • capability - The capability to get the trait category for
§Example
use ccxt_core::capability::{ExchangeCapabilities, Capability, TraitCategory};

let category = ExchangeCapabilities::trait_for_capability(Capability::FetchTicker);
assert_eq!(category, TraitCategory::MarketData);

Trait Implementations§

Source§

impl Clone for ExchangeCapabilities

Source§

fn clone(&self) -> ExchangeCapabilities

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 ExchangeCapabilities

Source§

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

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

impl Default for ExchangeCapabilities

Source§

fn default() -> ExchangeCapabilities

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

impl Display for ExchangeCapabilities

Source§

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

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

impl From<Capabilities> for ExchangeCapabilities

Source§

fn from(caps: Capabilities) -> ExchangeCapabilities

Converts to this type from the input type.
Source§

impl Hash for ExchangeCapabilities

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ExchangeCapabilities

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for ExchangeCapabilities

Source§

impl Eq for ExchangeCapabilities

Source§

impl StructuralPartialEq for ExchangeCapabilities

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

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

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
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T> ToStringFallible for T
where T: Display,

Source§

fn try_to_string(&self) -> Result<String, TryReserveError>

ToString::to_string, but without panic on OOM.

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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