AxOrdersWebSocketClient

Struct AxOrdersWebSocketClient 

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

Orders WebSocket client for Ax.

Provides authenticated order management including placing, canceling, and monitoring order status via WebSocket.

Implementations§

Source§

impl AxOrdersWebSocketClient

Source

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

Creates a new Ax orders WebSocket client.

Source

pub fn url(&self) -> &str

Returns the WebSocket URL.

Source

pub fn account_id(&self) -> AccountId

Returns the account ID.

Source

pub fn is_active(&self) -> bool

Returns whether the client is currently connected and active.

Source

pub fn is_closed(&self) -> bool

Returns whether the client is closed.

Source

pub fn cache_instrument(&self, instrument: InstrumentAny)

Caches an instrument for use during message parsing.

Source

pub fn get_cached_instrument(&self, symbol: &Ustr) -> Option<InstrumentAny>

Returns a cached instrument by symbol.

Source

pub async fn connect(&mut self, bearer_token: &str) -> AxOrdersWsResult<()>

Establishes the WebSocket connection with authentication.

§Arguments
  • bearer_token - The bearer token for authentication.
§Errors

Returns an error if the connection cannot be established.

Source

pub async fn place_order( &self, client_order_id: ClientOrderId, symbol: Ustr, side: AxOrderSide, quantity: i64, price: Decimal, time_in_force: AxTimeInForce, post_only: bool, tag: Option<String>, ) -> AxOrdersWsResult<i64>

Places an order via WebSocket.

§Errors

Returns an error if the order command cannot be sent.

Source

pub async fn cancel_order(&self, order_id: &str) -> AxOrdersWsResult<i64>

Cancels an order via WebSocket.

§Errors

Returns an error if the cancel command cannot be sent.

Source

pub async fn get_open_orders(&self) -> AxOrdersWsResult<i64>

Requests open orders via WebSocket.

§Errors

Returns an error if the request command cannot be sent.

Source

pub fn stream(&mut self) -> impl Stream<Item = AxOrdersWsMessage> + use<'_>

Returns a stream of messages from the WebSocket.

§Panics

Panics if called more than once or before connecting.

Source

pub async fn disconnect(&self)

Disconnects the WebSocket connection gracefully.

Source

pub async fn close(&mut self)

Closes the WebSocket connection and cleans up resources.

Trait Implementations§

Source§

impl Clone for AxOrdersWebSocketClient

Source§

fn clone(&self) -> Self

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 AxOrdersWebSocketClient

Source§

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

Formats the value using the given formatter. Read more

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> 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<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
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> Ungil for T
where T: Send,