Struct choices::warp::test::WsBuilder [−][src]
A Websocket builder for testing filters.
See module documentation for an overview.
Implementations
impl WsBuilder
[src]
pub fn path(self, p: &str) -> WsBuilder
[src]
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>,
[src]
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,
[src]
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
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut Tⓘ
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub 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;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub 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;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T> Instrument for T
[src]
pub 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;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
pub 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;
[src]
Notable traits for Instrumented<T>
impl<T> Future for Instrumented<T> where
T: Future, type Output = <T as Future>::Output;
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,