Skip to main content

WsClient

Struct WsClient 

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

WebSocket client for public and private streams.

Implementations§

Source§

impl WsClient

Source

pub async fn connect_public( channel: WsChannel, ) -> Result<(Self, UnboundedReceiver<WsMessage>), BybitError>

Create a new WebSocket client for public streams.

§Example
use bybit_client::ws::{WsClient, WsChannel};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let (client, mut receiver) = WsClient::connect_public(WsChannel::PublicLinear).await?;

    client.subscribe(&["orderbook.50.BTCUSDT"]).await?;

    while let Some(msg) = receiver.recv().await {
        println!("Received: {:?}", msg);
    }

    Ok(())
}
Source

pub async fn connect_private( api_key: impl Into<String>, api_secret: impl Into<String>, ) -> Result<(Self, UnboundedReceiver<WsMessage>), BybitError>

Create a new WebSocket client for private streams (requires authentication).

§Example
use bybit_client::ws::{WsClient, WsChannel};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let (client, mut receiver) = WsClient::connect_private(
        "api_key",
        "api_secret",
    ).await?;

    client.subscribe(&["position", "order", "execution"]).await?;

    while let Some(msg) = receiver.recv().await {
        println!("Received: {:?}", msg);
    }

    Ok(())
}
Source

pub async fn connect_with_config( config: ClientConfig, channel: WsChannel, ) -> Result<(Self, UnboundedReceiver<WsMessage>), BybitError>

Create a new WebSocket client with custom configuration.

Source

pub async fn subscribe(&self, topics: &[&str]) -> Result<(), BybitError>

Subscribe to topics.

Source

pub async fn unsubscribe(&self, topics: &[&str]) -> Result<(), BybitError>

Unsubscribe from topics.

Source

pub fn is_connected(&self) -> bool

Check if the client is connected.

Source

pub fn disconnect(&self)

Disconnect and stop the client.

Source

pub async fn subscribed_topics(&self) -> Vec<String>

Get the list of subscribed topics.

Source

pub fn channel(&self) -> WsChannel

Get the WebSocket channel.

Trait Implementations§

Source§

impl Drop for WsClient

Source§

fn drop(&mut self)

Executes the destructor for this type. 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: 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, 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