Skip to main content

ChainStreamClient

Struct ChainStreamClient 

Source
pub struct ChainStreamClient {
    pub server_url: String,
    pub stream_url: String,
    pub stream: StreamApi,
    pub debug: bool,
    /* private fields */
}
Expand description

Main ChainStream client that provides access to all SDK functionality

§Example

use chainstream_sdk::ChainStreamClient;

#[tokio::main]
async fn main() {
    let client = ChainStreamClient::new("your-access-token", None);

    // Use the stream API for real-time data
    client.stream.connect().await.unwrap();

    // Subscribe to token candles
    let unsub = client.stream.subscribe_token_candles(
        "sol",
        "So11111111111111111111111111111111111111112",
        "1s",
        |candle| {
            println!("Candle: {:?}", candle);
        },
        None,
    ).await.unwrap();
}

Fields§

§server_url: String

Base URL for REST API

§stream_url: String

WebSocket URL for Stream API

§stream: StreamApi

Stream API for real-time data subscriptions

§debug: bool

Debug mode flag

Implementations§

Source§

impl ChainStreamClient

Source

pub fn new( access_token: &str, options: Option<ChainStreamClientOptions>, ) -> Self

Create a new ChainStreamClient with an access token

§Arguments
  • access_token - The access token for authentication
  • options - Optional configuration options
§Example
use chainstream_sdk::{ChainStreamClient, ChainStreamClientOptions};

let client = ChainStreamClient::new("your-access-token", None);

// Or with custom options
let client = ChainStreamClient::new("your-access-token", Some(ChainStreamClientOptions {
    stream_url: Some("wss://custom-url.com/ws".to_string()),
    ..Default::default()
}));
Source

pub fn new_with_token_provider<T: TokenProvider>( token_provider: &T, options: Option<ChainStreamClientOptions>, ) -> Self

Create a new ChainStreamClient with a token provider for dynamic token refresh

§Arguments
  • token_provider - A token provider that can refresh tokens
  • options - Optional configuration options
Source

pub fn get_access_token(&self) -> &str

Get the current access token

Source

pub async fn close(&self)

Close all connections

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

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