AlpacaWebSocketClient

Struct AlpacaWebSocketClient 

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

WebSocket client for Alpaca API

Implementations§

Source§

impl AlpacaWebSocketClient

Source

pub fn new(credentials: Credentials, environment: Environment) -> Self

Create a new WebSocket client for stocks

Source

pub fn from_env(environment: Environment) -> Result<Self>

Create a new client from environment variables

Source

pub fn with_feed( credentials: Credentials, environment: Environment, feed: DataFeed, ) -> Self

Create a WebSocket client for a specific data feed

Source

pub fn crypto(credentials: Credentials, environment: Environment) -> Self

Create a crypto WebSocket client

Source

pub fn crypto_from_env(environment: Environment) -> Result<Self>

Create a crypto client from environment variables

Source

pub fn trading(credentials: Credentials, environment: Environment) -> Self

Create a trading WebSocket client

Source

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

Connect to the WebSocket and return a stream of messages

Source

pub async fn connect_with_reconnect( &self, max_retries: u32, ) -> Result<AlpacaStream>

Connect with automatic reconnection

Source

pub async fn subscribe_market_data( &self, subscription: SubscribeMessage, ) -> Result<MarketDataStream>

Subscribe to market data

Source

pub async fn subscribe_trading_updates(&self) -> Result<TradingStream>

Subscribe to trading updates

Source

pub async fn send_subscription( &self, subscription: SubscribeMessage, ) -> Result<()>

Send subscription message

Source

pub async fn send_unsubscription( &self, unsubscription: UnsubscribeMessage, ) -> Result<()>

Send unsubscription message

Source

pub fn url(&self) -> &str

Get the WebSocket URL

Source

pub fn environment(&self) -> &Environment

Get the environment

Trait Implementations§

Source§

impl Debug for AlpacaWebSocketClient

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> 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> Same for T

Source§

type Output = T

Should always be Self
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
Source§

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