Struct tokio_binance::UserDataClient

pub struct UserDataClient { /* fields omitted */ }

Client for dealing with the user data stream.

Implementations

impl UserDataClient

pub fn connect<A, U>(api_key: A, url: U) -> Result<Self> where
    A: Into<String>,
    U: Into<String>, 

Creates new client instance

Example

use tokio_binance::{UserDataClient, BINANCE_US_URL};
 
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = UserDataClient::connect("<api-key>", BINANCE_US_URL)?;
    Ok(())
}

pub fn start_stream(&self) -> ParamBuilder<'_, '_, StartStreamParams>

Start a new user data stream. The stream will close after 60 minutes unless a keepalive is sent.

Example

use serde_json::Value;
 
let response = client
    .start_stream()
    .json::<Value>()
    .await?;

pub fn keep_alive<'a>(
    &self,
    listen_key: &'a str
) -> ParamBuilder<'a, '_, KeepAliveStreamParams>

Keepalive a user data stream to prevent a time out. User data streams will close after 60 minutes. It's recommended to send a ping about every 30 minutes.

Example

use serde_json::Value;
 
let response = client
    .keep_alive("<listen-key>")
    .json::<Value>()
    .await?;

pub fn close_stream<'a>(
    &self,
    listen_key: &'a str
) -> ParamBuilder<'a, '_, CloseStreamParams>

Close out a user data stream.

Example

use serde_json::Value;
 
let response = client
    .close_stream("<listen-key>")
    .json::<Value>()
    .await?;

Trait Implementations

impl Clone for UserDataClient

fn clone(&self) -> UserDataClient

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.