Struct AuthRequest 

pub struct AuthRequest {
    pub apikey: Option<String>,
    pub token: Option<String>,
    pub sdk_token: Option<String>,
    pub heartbeat_interval_ms: Option<u64>,
}

WebSocket authentication request

Fields

apikey: Option<String>

API key (if using API key auth)

token: Option<String>

Bearer token (if using token auth)

sdk_token: Option<String>

SDK token (if using SDK token auth)

heartbeat_interval_ms: Option<u64>

Optional client-requested heartbeat interval in milliseconds. Server may honor or clamp; absent value means “use server default”.

Wire-only field in 3.x — there is no public builder method yet because the server side does not honor this preference. Once server support lands (Phase 2.3 in the SDK roadmap), a with_heartbeat_interval builder will be exposed. Pre-shipping the wire field here means deployed v3.x clients can negotiate without needing a fresh release.

Implementations

impl AuthRequest

pub fn with_api_key(api_key: impl Into<String>) -> AuthRequest

Create API key auth request

pub fn with_token(token: impl Into<String>) -> AuthRequest

Create bearer token auth request

pub fn with_sdk_token(sdk_token: impl Into<String>) -> AuthRequest

Create SDK token auth request

Trait Implementations

impl Clone for AuthRequest

fn clone(&self) -> AuthRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthRequest

fn deserialize<__D>( __deserializer: __D, ) -> Result<AuthRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AuthRequest

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.