Struct WebSocketConfig

pub struct WebSocketConfig<B>
where
    B: BroadcastTypeTrait,
{ /* private fields */ }

Configuration for a WebSocket connection.

This struct encapsulates all necessary parameters for setting up and managing a WebSocket connection, including context, buffer sizes, capacity, broadcast type, and various hook functions for different lifecycle events.

Type Parameters

• B: The type used for broadcast keys, which must implement BroadcastTypeTrait.

Implementations

impl<B> WebSocketConfig<B>

where B: BroadcastTypeTrait,

pub fn new() -> WebSocketConfig<B>

Creates a new WebSocket configuration with default values.

Returns

• WebSocketConfig<B> - A new WebSocket configuration instance.

pub fn set_buffer_size(self, buffer_size: usize) -> WebSocketConfig<B>

Sets the buffer size for the WebSocket connection.

Arguments

• usize - The desired buffer size in bytes.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn set_capacity(self, capacity: usize) -> WebSocketConfig<B>

Sets the capacity for the broadcast sender.

Arguments

• Capacity - The desired capacity.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn set_context(self, context: Context) -> WebSocketConfig<B>

Sets the context for the WebSocket connection.

Arguments

• Context - The context object to associate with the WebSocket.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn set_broadcast_type( self, broadcast_type: BroadcastType<B>, ) -> WebSocketConfig<B>

Sets the broadcast type for the WebSocket connection.

Arguments

• BroadcastType<B> - The broadcast type to use for this WebSocket.

Returns

• WebSocketConfig<B> - The modified WebSocket configuration instance.

pub fn set_request_hook<F, Fut>(self, hook: F) -> WebSocketConfig<B>

where F: Fn(Context) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Sets the request hook function.

This hook is executed when a new request is received.

Type Parameters

• F: The type of the function, which must be Fn(Context) -> Fut + Send + Sync + 'static.
• Fut: The future returned by the function, which must be Future<Output = ()> + Send + 'static.

Arguments

• hook - The function to be used as the request hook.

Returns

The modified WebSocket configuration instance.

pub fn set_sended_hook<F, Fut>(self, hook: F) -> WebSocketConfig<B>

where F: Fn(Context) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Sets the sended hook function.

This hook is executed after a message has been sent.

Type Parameters

• F: The type of the function, which must be Fn(Context) -> Fut + Send + Sync + 'static.
• Fut: The future returned by the function, which must be Future<Output = ()> + Send + 'static.

Arguments

• hook - The function to be used as the sended hook.

Returns

The modified WebSocket configuration instance.

pub fn set_closed_hook<F, Fut>(self, hook: F) -> WebSocketConfig<B>

where F: Fn(Context) -> Fut + Send + Sync + 'static, Fut: Future<Output = ()> + Send + 'static,

Sets the closed hook function.

This hook is executed when the WebSocket connection is closed.

Type Parameters

• F: The type of the function, which must be Fn(Context) -> Fut + Send + Sync + 'static.
• Fut: The future returned by the function, which must be Future<Output = ()> + Send + 'static.

Arguments

• hook - The function to be used as the closed hook.

Returns

The modified WebSocket configuration instance.

pub fn get_context(&self) -> &Context

Retrieves a reference to the context associated with this configuration.

Returns

• &Context - A reference to the context object.

pub fn get_buffer_size(&self) -> usize

Retrieves the buffer size configured for the WebSocket connection.

Returns

• usize - The buffer size in bytes.

pub fn get_capacity(&self) -> usize

Retrieves the capacity configured for the broadcast sender.

Returns

• Capacity - The capacity.

pub fn get_broadcast_type(&self) -> &BroadcastType<B>

Retrieves a reference to the broadcast type configured for this WebSocket.

Returns

• &BroadcastType<B> - A reference to the broadcast type object.

pub fn get_request_hook( &self, ) -> &Arc<dyn FnContextPinBoxSendSync<(), Output = Pin<Box<dyn Future<Output = ()> + Send>>>>

Retrieves a reference to the request hook function.

Returns

• &ArcFnContextPinBoxSendSync<()> - A reference to the request hook.

pub fn get_sended_hook( &self, ) -> &Arc<dyn FnContextPinBoxSendSync<(), Output = Pin<Box<dyn Future<Output = ()> + Send>>>>

Retrieves a reference to the sended hook function.

Returns

• &ArcFnContextPinBoxSendSync<()> - A reference to the sended hook.

pub fn get_closed_hook( &self, ) -> &Arc<dyn FnContextPinBoxSendSync<(), Output = Pin<Box<dyn Future<Output = ()> + Send>>>>

Retrieves a reference to the closed hook function.

Returns

• &ArcFnContextPinBoxSendSync<()> - A reference to the closed hook.

Trait Implementations

impl<B> Clone for WebSocketConfig<B>

where B: Clone + BroadcastTypeTrait,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<B> Default for WebSocketConfig<B>

where B: BroadcastTypeTrait,

Implements the Default trait for WebSocketConfig.

Provides a default configuration for WebSocket connections, including default hook functions that do nothing.

Type Parameters

• B: The type parameter for WebSocketConfig, which must implement BroadcastTypeTrait.

fn default() -> WebSocketConfig<B>

Returns the “default value” for a type.