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) -> Self where
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
pub fn header<K, V>(self, key: K, value: V) -> Self where
HeaderName: TryFrom<K>,
HeaderValue: TryFrom<V>,
sourcepub async fn handshake<F>(self, f: F) -> Result<WsClient, WsError> where
F: Filter + Clone + Send + Sync + 'static,
F::Extract: Reply + Send,
F::Error: IsReject + Send,
pub async fn handshake<F>(self, f: F) -> Result<WsClient, WsError> where
F: Filter + Clone + Send + Sync + 'static,
F::Extract: Reply + Send,
F::Error: IsReject + Send,
Execute this Websocket request against the provided filter.
If the handshake succeeds, returns a WsClient
.
Example
use futures::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 · sourcepub fn borrow_mut(&mut self) -> &mut T
pub 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>
fn instrument(self, span: Span) -> Instrumented<Self>
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self