rama::http::ws::handshake::client

Struct WebSocketRequestBuilder

pub struct WebSocketRequestBuilder<B> { /* private fields */ }
Expand description

Builder that can be used by clients to initiate the WebSocket handshake.

Implementations§

§

impl WebSocketRequestBuilder<Builder>

pub fn new<T>(uri: T) -> WebSocketRequestBuilder<Builder>
where T: TryInto<Uri>, <T as TryInto<Uri>>::Error: Into<Error>,

Create a new http/1.1 WebSocket Request builder.

pub fn new_h2<T>(uri: T) -> WebSocketRequestBuilder<Builder>
where T: TryInto<Uri>, <T as TryInto<Uri>>::Error: Into<Error>,

Create a new h2 WebSocket Request builder.

pub fn with_header<K, V>( self, name: K, value: V, ) -> WebSocketRequestBuilder<Builder>
where K: TryInto<HeaderName>, <K as TryInto<HeaderName>>::Error: Into<Error>, V: TryInto<HeaderValue>, <V as TryInto<HeaderValue>>::Error: Into<Error>,

Set a custom http header

pub fn with_typed_header<H>(self, header: H) -> WebSocketRequestBuilder<Builder>
where H: HeaderEncode,

Set a custom typed http header

pub fn build_handshake(self) -> Result<HandshakeRequest, OpaqueError>

Build the handshake data to be used to initiate the WebSocket handshake using an http client.

§

impl<'a, S, Body> WebSocketRequestBuilder<WithService<'a, S, Body>>
where S: Service<Request, Response = Response<Body>>, <S as Service<Request>>::Error: Into<Box<dyn Error + Sync + Send>>,

pub fn new_with_service<T>( service: &'a S, uri: T, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>
where T: IntoUrl,

Create a new http/1.1 WebSocket Request builder.

pub fn new_h2_with_service<T>( service: &'a S, uri: T, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>
where T: IntoUrl,

Create a new h2 WebSocket Request builder.

pub fn new_with_service_and_request<RequestBody>( service: &'a S, request: Request<RequestBody>, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>
where RequestBody: Into<Body>,

Create a new WebSocket Request builder for the given Request

pub fn with_header<K, V>( self, name: K, value: V, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>
where K: IntoHeaderName, V: IntoHeaderValue,

Set a custom http header

pub fn with_header_overwrite<K, V>( self, name: K, value: V, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>
where K: IntoHeaderName, V: IntoHeaderValue,

Overwrite a custom http header

pub fn with_typed_header<H>( self, header: H, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>
where H: HeaderEncode,

Set a custom typed http header

pub fn with_typed_header_overwrite<H>( self, header: H, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>
where H: HeaderEncode,

Overwrite a custom typed http header

pub fn with_per_message_deflate( self, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

pub fn set_per_message_deflate( &mut self, ) -> &mut WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

pub fn with_per_message_deflate_overwrite_extensions( self, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

Overwrites existing extensions if already existed.

pub fn set_per_message_deflate_overwrite_extensions( &mut self, ) -> &mut WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

Overwrites existing extensions if already existed.

pub fn with_per_message_deflate_with_config( self, config: impl Into<PerMessageDeflateConfig>, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

pub fn set_per_message_deflate_with_config( &mut self, config: impl Into<PerMessageDeflateConfig>, ) -> &mut WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

pub fn with_per_message_deflate_with_config_overwrite_extensions( self, config: impl Into<PerMessageDeflateConfig>, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

Overwrites existing extensions if already existed.

pub fn set_per_message_deflate_with_config_overwrite_extensions( &mut self, config: impl Into<PerMessageDeflateConfig>, ) -> &mut WebSocketRequestBuilder<WithService<'a, S, Body>>

Set/add deflate ext and also apply it to the WebSocketConfig, using the default crate::protocol::PerMessageDeflateConfig.

Overwrites existing extensions if already existed.

pub fn maybe_with_config( self, cfg: Option<WebSocketConfig>, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>

Set the WebSocketConfig, overwriting the previous config if already set.

pub fn maybe_set_config( &mut self, cfg: Option<WebSocketConfig>, ) -> &mut WebSocketRequestBuilder<WithService<'a, S, Body>>

Set the WebSocketConfig, overwriting the previous config if already set.

pub fn with_config( self, cfg: WebSocketConfig, ) -> WebSocketRequestBuilder<WithService<'a, S, Body>>

Set the WebSocketConfig, overwriting the previous config if already set.

pub fn set_config( &mut self, cfg: WebSocketConfig, ) -> &mut WebSocketRequestBuilder<WithService<'a, S, Body>>

Set the WebSocketConfig, overwriting the previous config if already set.

pub fn without_config(self) -> WebSocketRequestBuilder<WithService<'a, S, Body>>

Set the WebSocketConfig, overwriting the previous config if already set.

pub fn unset_config( &mut self, ) -> &mut WebSocketRequestBuilder<WithService<'a, S, Body>>

Set the WebSocketConfig, overwriting the previous config if already set.

pub async fn initiate_handshake( self, ctx: Context, ) -> Result<NegotiatedHandshakeRequest<Body>, HandshakeError>

Initiate the handshake by preparing the http request, sending it and receiving the http response.

This consumes this WebSocketRequestBuilder. Fulfill the handshake by calling NegotiatedHandshakeRequest::complete.

In most cases you have however no need for this intermediate result, and are better of calling Self::handshake directly. Only in cases such as MITM proxies or edge-case purposes you might require access to NegotiatedHandshakeRequest.

pub async fn handshake( self, ctx: Context, ) -> Result<ClientWebSocket, HandshakeError>

Establish a client [WebSocket], consuming this WebSocketRequestBuilder, by doing the http-handshake, including validation and returning the socket if all is good.

§

impl<B> WebSocketRequestBuilder<B>

pub fn maybe_with_protocols( self, protocols: Option<SecWebSocketProtocol>, ) -> WebSocketRequestBuilder<B>

Define the WebSocket protocols to be used.

pub fn maybe_set_protocols( &mut self, protocols: Option<SecWebSocketProtocol>, ) -> &mut WebSocketRequestBuilder<B>

Define the WebSocket protocols to be used.

pub fn with_protocols( self, protocols: SecWebSocketProtocol, ) -> WebSocketRequestBuilder<B>

Define the WebSocket protocols to be used.

pub fn set_protocols( &mut self, protocols: SecWebSocketProtocol, ) -> &mut WebSocketRequestBuilder<B>

Define the WebSocket protocols to be used.

pub fn without_protocols(self) -> WebSocketRequestBuilder<B>

Define the WebSocket protocols to be used.

pub fn unset_protocols(&mut self) -> &mut WebSocketRequestBuilder<B>

Define the WebSocket protocols to be used.

pub fn maybe_with_key( self, key: Option<SecWebSocketKey>, ) -> WebSocketRequestBuilder<B>

Set the WebSocket key (a random one will be generated if not defined).

Only touch this property if you have a good reason to do so.

pub fn maybe_set_key( &mut self, key: Option<SecWebSocketKey>, ) -> &mut WebSocketRequestBuilder<B>

Set the WebSocket key (a random one will be generated if not defined).

Only touch this property if you have a good reason to do so.

pub fn with_key(self, key: SecWebSocketKey) -> WebSocketRequestBuilder<B>

Set the WebSocket key (a random one will be generated if not defined).

Only touch this property if you have a good reason to do so.

pub fn set_key( &mut self, key: SecWebSocketKey, ) -> &mut WebSocketRequestBuilder<B>

Set the WebSocket key (a random one will be generated if not defined).

Only touch this property if you have a good reason to do so.

pub fn without_key(self) -> WebSocketRequestBuilder<B>

Set the WebSocket key (a random one will be generated if not defined).

Only touch this property if you have a good reason to do so.

pub fn unset_key(&mut self) -> &mut WebSocketRequestBuilder<B>

Set the WebSocket key (a random one will be generated if not defined).

Only touch this property if you have a good reason to do so.

Trait Implementations§

§

impl<B> Clone for WebSocketRequestBuilder<B>
where B: Clone,

§

fn clone(&self) -> WebSocketRequestBuilder<B>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<B> Debug for WebSocketRequestBuilder<B>
where B: Debug,

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaFrom<T> for U
where U: From<T>,

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

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

§

type Error = <U as TryFrom<T>>::Error

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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

Source§

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
§

impl<T> ErasedDestructor for T
where T: 'static,