pub struct FuturesWebSockets<'a, WE> {
    pub socket: Option<(WebSocketStream<MaybeTlsStream<TcpStream>>, Response)>,
    /* private fields */
}

Fields§

§socket: Option<(WebSocketStream<MaybeTlsStream<TcpStream>>, Response)>

Implementations§

source§

impl<'a, WE: DeserializeOwned> FuturesWebSockets<'a, WE>

source

pub fn new<Callback>(handler: Callback) -> FuturesWebSockets<'a, WE>
where Callback: FnMut(WE) -> Result<()> + 'a + Send,

New websocket holder with default configuration

Examples

see examples/binance_websockets.rs

source

pub fn new_with_options<Callback>( handler: Callback, conf: Config ) -> FuturesWebSockets<'a, WE>
where Callback: FnMut(WE) -> Result<()> + 'a + Send,

New websocket holder with provided configuration

Examples

see examples/binance_websockets.rs

source

pub async fn connect_multiple(&mut self, endpoints: Vec<String>) -> Result<()>

Connect to multiple websocket endpoints N.B: WE has to be CombinedStreamEvent

source

pub async fn connect(&mut self, endpoint: &str) -> Result<()>

Connect to a websocket endpoint

source

pub async fn disconnect(&mut self) -> Result<()>

Disconnect from the endpoint

source

pub fn socket( &self ) -> &Option<(WebSocketStream<MaybeTlsStream<TcpStream>>, Response)>

source

pub async fn event_loop(&mut self, running: &AtomicBool) -> Result<()>

Auto Trait Implementations§

§

impl<'a, WE> !RefUnwindSafe for FuturesWebSockets<'a, WE>

§

impl<'a, WE> Send for FuturesWebSockets<'a, WE>

§

impl<'a, WE> !Sync for FuturesWebSockets<'a, WE>

§

impl<'a, WE> Unpin for FuturesWebSockets<'a, WE>

§

impl<'a, WE> !UnwindSafe for FuturesWebSockets<'a, WE>

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.

§

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

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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