pub struct WsBuilder { /* private fields */ }
Expand description
A Websocket builder for testing filters.
See module documentation for an overview.
Implementations
sourceimpl WsBuilder
impl WsBuilder
sourcepub fn header<K, V>(self, key: K, value: V) -> WsBuilder where
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
pub fn header<K, V>(self, key: K, value: V) -> WsBuilder where
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
sourcepub async fn handshake<F>(self, f: F) -> Result<WsClient, WsError> where
F: 'static + Filter + Clone + Send + Sync,
<F as FilterBase>::Extract: Reply,
<F as FilterBase>::Extract: Send,
<F as FilterBase>::Error: IsReject,
<F as FilterBase>::Error: Send,
pub async fn handshake<F>(self, f: F) -> Result<WsClient, WsError> where
F: 'static + Filter + Clone + Send + Sync,
<F as FilterBase>::Extract: Reply,
<F as FilterBase>::Extract: Send,
<F as FilterBase>::Error: IsReject,
<F as FilterBase>::Error: Send,
Execute this Websocket request against the provided filter.
If the handshake succeeds, returns a WsClient
.
Example
use futures_util::future;
use warp::Filter;
#[tokio::main]
// Some route that accepts websockets (but drops them immediately).
let route = warp::ws()
.map(|ws: warp::ws::Ws| {
ws.on_upgrade(|_| future::ready(()))
});
let client = warp::test::ws()
.handshake(route)
.await
.expect("handshake");
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for WsBuilder
impl Send for WsBuilder
impl Sync for WsBuilder
impl Unpin for WsBuilder
impl !UnwindSafe for WsBuilder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn instrument(self, span: Span) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
sourcefn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
fn in_current_span(self) -> Instrumented<Self>ⓘNotable traits for Instrumented<T>impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
where
S: Into<Dispatch>,
T: Future, type Output = <T as Future>::Output;
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
fn with_current_subscriber(self) -> WithDispatch<Self>ⓘNotable traits for WithDispatch<T>impl<T> Future for WithDispatch<T> where
T: Future, type Output = <T as Future>::Output;
T: Future, type Output = <T as Future>::Output;
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more