Struct choices::warp::test::WsBuilder

#[must_use = "WsBuilder does nothing on its own"]
pub struct WsBuilder { /* fields omitted */ }

A Websocket builder for testing filters.

See module documentation for an overview.

Implementations

impl WsBuilder

pub fn path(self, p: &str) -> WsBuilder

Sets the request path of this builder.

The default is not set is /.

Example

let req = warp::test::ws()
    .path("/chat");

Panic

This panics if the passed string is not able to be parsed as a valid Uri.

pub fn header<K, V>(self, key: K, value: V) -> WsBuilder where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>, 

Set a header for this request.

Example

let req = warp::test::ws()
    .header("foo", "bar");

Panic

This panics if the passed strings are not able to be parsed as a valid HeaderName and HeaderValue.

pub async fn handshake<F>(self, f: F) -> Result<WsClient, WsError> where
    F: Filter + Clone + Send + Sync + 'static,
    <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::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

impl Debug for WsBuilder

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

Formats the value using the given formatter.