Struct StreamConfig 

pub struct StreamConfig {
    pub endpoint: String,
    pub api_key: String,
    pub staleness_threshold: Duration,
}

Configuration for a single stream connection.

Fields

endpoint: String

api_key: String

staleness_threshold: Duration

Implementations

impl StreamConfig

pub fn mainnet(api_key: impl Into<String>) -> Self

Default mainnet endpoint.

Examples found in repository

examples/basic_stream.rs (line 20)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    // No logger init — keeps example dependency-free.
    // The crate uses `log` facade; to see internal logs, add env_logger
    // (or any log backend) to your binary's Cargo.toml and init here.

    let api_key = std::env::var("HELIUS_API_KEY")
        .map_err(|_| "set HELIUS_API_KEY in environment")?;

    let config = StreamConfig::mainnet(api_key);
    let mut stream = HeliusStream::connect(config)?;

    println!("[INIT] subscribing to USDC mint");
    stream.subscribe_account_b58(USDC_MINT)?;

    let mut received = 0;
    while let Some(update) = stream.next_update() {
        received += 1;
        println!(
            "[UPDATE] slot={} lamports={} data_bytes={} safe={} gap_rate={:.3}",
            update.slot,
            update.lamports,
            update.data.len(),
            stream.is_safe_for_simulation(),
            stream.health().gap_rate(),
        );
        if received >= 10 {
            println!("[DONE] received 10 updates, exiting");
            break;
        }
    }
    Ok(())
}

pub fn devnet(api_key: impl Into<String>) -> Self

Default devnet endpoint.

pub fn custom(endpoint: impl Into<String>, api_key: impl Into<String>) -> Self

Custom endpoint (e.g., an enterprise / dedicated node URL).

pub fn staleness_threshold(self, d: Duration) -> Self

How long without an update before the stream is considered stale. Default: 500ms.

Trait Implementations

impl Clone for StreamConfig

fn clone(&self) -> StreamConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.