rama::http::ws::handshake::server

Struct WebSocketAcceptor

pub struct WebSocketAcceptor { /* private fields */ }

Expand description

An acceptor that can be used for upgrades os WebSockets on the server side.

Implementations§

impl WebSocketAcceptor

pub fn new() -> WebSocketAcceptor

Create a new default WebSocketAcceptor.

pub fn with_protocols_flex(self, flexible: bool) -> WebSocketAcceptor

Define if the protocols validation and actioning is flexible.

In case no protocols are defined by server it implies that the server will accept any incoming protocol instead of denying protocols.
Or in case server did specify a protocol allow list it will also accept incoming requests which do not define a protocol.

pub fn set_protocols_flex(&mut self, flexible: bool) -> &mut WebSocketAcceptor

Define if the protocols validation and actioning is flexible.

In case no protocols are defined by server it implies that the server will accept any incoming protocol instead of denying protocols.
Or in case server did specify a protocol allow list it will also accept incoming requests which do not define a protocol.

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

Define the WebSocket protocols.

The protocols defined by the server (matcher) act as an allow list. You can make protocols optional in case you also wish to allow no protocols to be defined by marking protocols as flexible.

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

Define the WebSocket protocols.

The protocols defined by the server (matcher) act as an allow list. You can make protocols optional in case you also wish to allow no protocols to be defined by marking protocols as flexible.

pub fn with_protocols( self, protocols: SecWebSocketProtocol, ) -> WebSocketAcceptor

Define the WebSocket protocols.

The protocols defined by the server (matcher) act as an allow list. You can make protocols optional in case you also wish to allow no protocols to be defined by marking protocols as flexible.

pub fn set_protocols( &mut self, protocols: SecWebSocketProtocol, ) -> &mut WebSocketAcceptor

Define the WebSocket protocols.

The protocols defined by the server (matcher) act as an allow list. You can make protocols optional in case you also wish to allow no protocols to be defined by marking protocols as flexible.

pub fn without_protocols(self) -> WebSocketAcceptor

Define the WebSocket protocols.

The protocols defined by the server (matcher) act as an allow list. You can make protocols optional in case you also wish to allow no protocols to be defined by marking protocols as flexible.

pub fn unset_protocols(&mut self) -> &mut WebSocketAcceptor

Define the WebSocket protocols.

The protocols defined by the server (matcher) act as an allow list. You can make protocols optional in case you also wish to allow no protocols to be defined by marking protocols as flexible.

pub fn with_echo_protocols(self) -> WebSocketAcceptor

Define the WebSocket rama echo protocols.

pub fn set_echo_protocols(&mut self) -> &mut WebSocketAcceptor

Define the WebSocket rama echo protocols.

pub fn maybe_with_extensions( self, extensions: Option<SecWebSocketExtensions>, ) -> WebSocketAcceptor

Define the WebSocket extensions to be supported by the server.

pub fn maybe_set_extensions( &mut self, extensions: Option<SecWebSocketExtensions>, ) -> &mut WebSocketAcceptor

Define the WebSocket extensions to be supported by the server.

pub fn with_extensions( self, extensions: SecWebSocketExtensions, ) -> WebSocketAcceptor

Define the WebSocket extensions to be supported by the server.

pub fn set_extensions( &mut self, extensions: SecWebSocketExtensions, ) -> &mut WebSocketAcceptor

Define the WebSocket extensions to be supported by the server.

pub fn without_extensions(self) -> WebSocketAcceptor

Define the WebSocket extensions to be supported by the server.

pub fn unset_extensions(&mut self) -> &mut WebSocketAcceptor

Define the WebSocket extensions to be supported by the server.

pub fn with_per_message_deflate(self) -> WebSocketAcceptor

Set or add the deflate WebSocket extension with the default config

pub fn set_per_message_deflate(&mut self) -> &mut WebSocketAcceptor

Set or add the deflate WebSocket extension with the default config

pub fn with_per_message_deflate_overwrite_extensions(self) -> WebSocketAcceptor

Set the deflate WebSocket extension with the default config, erasing existing if it already exists.

pub fn set_per_message_deflate_overwrite_extensions( &mut self, ) -> &mut WebSocketAcceptor

Set the deflate WebSocket extension with the default config, erasing existing if it already exists.

pub fn with_per_message_deflate_with_config( self, config: impl Into<PerMessageDeflateConfig>, ) -> WebSocketAcceptor

Set or add the deflate WebSocket extension with the given config, erasing existing if it already exists.

pub fn set_per_message_deflate_with_config( &mut self, config: impl Into<PerMessageDeflateConfig>, ) -> &mut WebSocketAcceptor

Set or add the deflate WebSocket extension with the given config, erasing existing if it already exists.

pub fn with_per_message_deflate_with_config_overwrite_extensions( self, config: impl Into<PerMessageDeflateConfig>, ) -> WebSocketAcceptor

Set or add the deflate WebSocket extension with the given config, erasing existing if it already exists.

pub fn set_per_message_deflate_with_config_overwrite_extensions( &mut self, config: impl Into<PerMessageDeflateConfig>, ) -> &mut WebSocketAcceptor

Set or add the deflate WebSocket extension with the given config, erasing existing if it already exists.

impl WebSocketAcceptor

pub fn into_service<S>(self, service: S) -> WebSocketAcceptorService<S>

Consume self into an WebSocketAcceptorService ready to serve.

Use the UpgradeLayer in case the ws upgrade is optional.

pub fn into_echo_service(self) -> WebSocketAcceptorService<WebSocketEchoService>

Turn this WebSocketAcceptor into an echo WebSocketAcceptorService].

Trait Implementations§

impl Clone for WebSocketAcceptor

fn clone(&self) -> WebSocketAcceptor

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 Debug for WebSocketAcceptor

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

Formats the value using the given formatter. Read more

impl Default for WebSocketAcceptor

fn default() -> WebSocketAcceptor

Returns the “default value” for a type. Read more

impl<Body> Service<Request<Body>> for WebSocketAcceptor
where Body: Send + 'static,

type Response = (Response<Body>, Context, Request<Body>)

The type of response returned by the service.

type Error = Response<Body>

The type of error returned by the service.

async fn serve( &self, ctx: Context, req: Request<Body>, ) -> Result<<WebSocketAcceptor as Service<Request<Body>>>::Response, <WebSocketAcceptor as Service<Request<Body>>>::Error>

Serve a response or error for the given request, using the given context.

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

impl Freeze for WebSocketAcceptor

impl RefUnwindSafe for WebSocketAcceptor

impl Send for WebSocketAcceptor

impl Sync for WebSocketAcceptor

impl Unpin for WebSocketAcceptor

impl UnwindSafe for WebSocketAcceptor

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

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>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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> RamaInto<U> for T
where U: RamaFrom<T>,

fn rama_into(self) -> U

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

fn rama_into(self) -> U

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

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

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

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

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

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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,