PythLazerClient

Struct PythLazerClient 

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

A high-performance client for connecting to Pyth Lazer data streams.

The PythLazerClient maintains multiple WebSocket connections to Pyth Lazer endpoints for redundancy. It automatically handles connection management, message deduplication, and provides a unified stream of price updates.

§Architecture

  • Maintains multiple WebSocket connections to different endpoints
  • Uses a TTL cache for deduplicating messages across connections
  • Provides a single channel for consuming deduplicated messages
  • Handles connection failures with exponential backoff

Implementations§

Source§

impl PythLazerClient

Source

pub fn new( endpoints: Vec<Url>, access_token: String, num_connections: usize, backoff: PythLazerExponentialBackoff, timeout: Duration, channel_capacity: usize, ) -> Result<Self>

Creates a new Pyth Lazer client instance.

This is a low-level constructor. Consider using PythLazerClientBuilder for a more convenient way to create clients with sensible defaults.

§Arguments
  • endpoints - A vector of WebSocket endpoint URLs to connect to. Must not be empty.
  • access_token - The authentication token for accessing Pyth Lazer services
  • num_connections - The number of WebSocket connections to maintain for redundancy
  • backoff - The exponential backoff configuration for connection retries
  • timeout - The timeout duration for WebSocket operations
  • channel_capacity - The capacity of the message channel
§Returns

Returns Ok(PythLazerClient) on success, or an error if the configuration is invalid.

§Errors

Returns an error if:

  • The endpoints vector is empty
Source

pub async fn start(&mut self) -> Result<Receiver<AnyResponse>>

Starts the client and begins establishing WebSocket connections.

This method initializes all WebSocket connections and starts the message processing loop. It returns a receiver channel that will yield deduplicated messages from all connections.

§Returns

Returns a Receiver<AnyResponse> that yields deduplicated messages from all WebSocket connections. The receiver will continue to yield messages until all connections are closed or the client is dropped.

§Errors

This method itself doesn’t return errors, but individual connection failures are handled internally with automatic reconnection using the configured backoff strategy.

§Message Deduplication

Messages are deduplicated using a TTL cache with a 10-second window. This ensures that identical messages received from multiple connections are only delivered once.

Source

pub async fn subscribe( &mut self, subscribe_request: SubscribeRequest, ) -> Result<()>

Subscribes to data streams across all WebSocket connections.

This method sends the subscription request to all active WebSocket connections, ensuring redundancy. If any connection fails to subscribe, an error is returned, but other connections may still be subscribed.

§Arguments
  • subscribe_request - The subscription request specifying which data streams to subscribe to
§Returns

Returns Ok(()) if the subscription was successfully sent to all connections, or an error if any connection failed to process the subscription.

Source

pub async fn unsubscribe( &mut self, subscription_id: SubscriptionId, ) -> Result<()>

Unsubscribes from a specific data stream across all WebSocket connections.

This method sends an unsubscribe request for the specified subscription ID to all active WebSocket connections.

§Arguments
  • subscription_id - The ID of the subscription to cancel
§Returns

Returns Ok(()) if the unsubscribe request was successfully sent to all connections, or an error if any connection failed to process the request.

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