Skip to main content

KalshiWebSocketClient

Struct KalshiWebSocketClient 

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

One multiplexed Predictions connection with reference-counted subscription intent.

Subscription calls record intent; events report venue confirmation or failure. Intent survives disconnect and stop. Reset clears it, and dispose permanently closes admission. Automatic transport reconnection is disabled. After an unexpected disconnect, call stop before connect to create a freshly signed connection and restore retained intent. Clones share lifecycle, subscription intent, and task ownership.

Implementations§

Source§

impl KalshiWebSocketClient

Source

pub fn new( config: KalshiDataClientConfig, ) -> Result<(Self, UnboundedReceiver<KalshiWsEvent>)>

Creates a disconnected client and its unbounded event receiver.

§Errors

Returns an error if configuration is invalid.

Source

pub async fn connect(&self) -> Result<()>

Connects, authenticates, and waits for retained subscriptions to be confirmed.

§Errors

Returns an error if the client is disposed, credentials or signing fail, the connection or task admission fails, or retained subscriptions are not restored before the timeout.

Source

pub fn is_active(&self) -> bool

Returns whether the authenticated transport and retained subscriptions are ready.

Source

pub fn subscribe(&self, subscription: KalshiSubscription) -> Result<()>

Adds one local reference and records intent, including before connection.

§Errors

Returns an error if arguments are invalid, the client is disposed, or the handler is stopped.

Source

pub fn unsubscribe(&self, subscription: &KalshiSubscription) -> Result<()>

Removes one local reference; the final removal cancels replay intent.

§Errors

Returns an error if arguments are invalid or the handler is stopped.

Source

pub fn update_subscription( &self, original: &KalshiSubscription, action: KalshiUpdateAction, markets: Vec<String>, ) -> Result<()>

Updates the shared subscription identified by its original arguments.

Adds and deletes change retained replay intent. Snapshot requests are connection-bound. Removing every explicitly selected market requires unsubscribe instead.

§Errors

Returns an error if the client is disposed, the channel or filter change is unsupported, intent is absent, markets are empty or duplicated, all markets would be deleted, the handler is stopped, or a snapshot is requested before the connection is ready.

Source

pub async fn stop(&self) -> Result<()>

Stops the connection and drains owned tasks while retaining subscription intent.

§Errors

Returns an error if bounded task teardown fails.

Source

pub async fn reset(&self) -> Result<()>

Stops the connection and clears subscription intent and reference counts.

§Errors

Returns an error if bounded task teardown fails.

Source

pub async fn dispose(&self) -> Result<()>

Stops the connection and permanently rejects new connection and subscription requests.

§Errors

Returns an error if bounded task teardown fails.

Trait Implementations§

Source§

impl Clone for KalshiWebSocketClient

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KalshiWebSocketClient

Source§

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

Formats the value using the given formatter. 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + 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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

impl<T> Ungil for T
where T: Send,

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more