Skip to main content

WebSocketClient

fmp_rust_sdk::websocket

Struct WebSocketClient 

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

An authenticated connector to FMP’s legacy stock, crypto, or forex cluster.

For current market streams, use StandardWebSocketClient.

Implementations§

Source§

impl WebSocketClient

Source

pub async fn connect( api_key: &str, subscription: &Subscription, cluster: WebSocketCluster, config: WebSocketConfig, ) -> Result<Self, WebSocketError>

Connects to the documented legacy cluster endpoint and confirms login.

Source

pub async fn connect_to( api_key: &str, subscription: &Subscription, cluster: WebSocketCluster, endpoint: Url, config: WebSocketConfig, ) -> Result<Self, WebSocketError>

Connects to a trusted explicit legacy endpoint; ws is loopback-only.

Source

pub const fn cluster(&self) -> WebSocketCluster

Returns the legacy cluster used by this connector.

Source

pub async fn subscribe( &mut self, symbols: &[&str], ) -> Result<(), WebSocketError>

Subscribes to validated lowercase legacy ticker symbols.

Source

pub async fn unsubscribe( &mut self, symbols: &[&str], ) -> Result<(), WebSocketError>

Unsubscribes from validated lowercase legacy ticker symbols.

Source

pub async fn next_event(&mut self) -> Result<WebSocketEvent, WebSocketError>

Receives a typed update, control, pong, or remote close event.

Source

pub async fn close(self) -> Result<(), WebSocketError>

Completes a close handshake within the configured timeout.

Trait Implementations§

Source§

impl Debug for WebSocketClient

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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