Struct RequestConfig 

pub struct RequestConfig(/* private fields */);

Thread-safe configuration wrapper for HTTP request parsing.

This struct uses ArcRwLock to provide thread-safe access to RequestConfigData , allowing concurrent reads and exclusive writes. It is the public-facing API for configuring HTTP request parsing limits.

Implementations

impl RequestConfig

pub async fn new() -> RequestConfig

Creates a new RequestConfig with default secure settings.

This constructor initializes the configuration with standard security limits suitable for most HTTP request parsing scenarios.

Returns

• Self - A new RequestConfig instance with default settings.

pub fn from_json<C>(json: C) -> Result<RequestConfig, Error>

where C: AsRef<str>,

Creates a new RequestConfig from a JSON string.

Arguments

• AsRef<str> - The configuration.

Returns

• Result<RequestConfig, serde_json::Error> - The parsed RequestConfig or an error.

pub async fn high_security() -> RequestConfig

Creates a new RequestConfig with high-security settings.

This constructor initializes the configuration with more restrictive limits to provide maximum protection against various attacks in high-risk environments.

Returns

• Self - A new RequestConfig instance with high-security settings.

pub async fn data(&self, data: RequestConfigData) -> &RequestConfig

Sets the configuration data.

Arguments

• RequestConfigData - The configuration data.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn get_data(&self) -> RequestConfigData

Gets the configuration data.

Returns

• RequestConfigData - The inner configuration.

pub async fn buffer_size(&self, buffer_size: usize) -> &RequestConfig

Sets the buffer size for reading operations.

Arguments

• usize - The buffer size in bytes.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_request_line_length( &self, max_request_line_length: usize, ) -> &RequestConfig

Sets the maximum length for HTTP request line in bytes.

Arguments

• usize - The maximum request line length.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_path_length(&self, max_path_length: usize) -> &RequestConfig

Sets the maximum length for URL path in bytes.

Arguments

• usize - The maximum path length.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_query_length(&self, max_query_length: usize) -> &RequestConfig

Sets the maximum length for query string in bytes.

Arguments

• usize - The maximum query string length.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_header_line_length( &self, max_header_line_length: usize, ) -> &RequestConfig

Sets the maximum length for a single header line in bytes.

Arguments

• usize - The maximum header line length.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_header_count(&self, max_header_count: usize) -> &RequestConfig

Sets the maximum number of headers allowed in a request.

Arguments

• usize - The maximum header count.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_header_key_length( &self, max_header_key_length: usize, ) -> &RequestConfig

Sets the maximum length for a header key in bytes.

Arguments

• usize - The maximum header key length.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_header_value_length( &self, max_header_value_length: usize, ) -> &RequestConfig

Sets the maximum length for a header value in bytes.

Arguments

• usize - The maximum header value length.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_body_size(&self, max_body_size: usize) -> &RequestConfig

Sets the maximum size for request body in bytes.

Arguments

• usize - The maximum body size.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_ws_frame_size( &self, max_ws_frame_size: usize, ) -> &RequestConfig

Sets the maximum size for WebSocket frame in bytes.

Arguments

• usize - The maximum WebSocket frame size.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn max_ws_frames(&self, max_ws_frames: usize) -> &RequestConfig

Sets the maximum number of WebSocket frames to process in a single request.

Arguments

• usize - The maximum WebSocket frames count.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn http_read_timeout_ms( &self, http_read_timeout_ms: u64, ) -> &RequestConfig

Sets the timeout for reading HTTP request in milliseconds.

Arguments

• u64 - The HTTP read timeout in milliseconds.

Returns

• &Self - The RequestConfig instance for chaining.

pub async fn ws_read_timeout_ms( &self, ws_read_timeout_ms: u64, ) -> &RequestConfig

Sets the timeout for reading WebSocket frames in milliseconds.

Arguments

• u64 - The WebSocket read timeout in milliseconds.

Returns

• &Self - The RequestConfig instance for chaining.

Trait Implementations

impl Clone for RequestConfig

fn clone(&self) -> RequestConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestConfig

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

Formats the value using the given formatter.

impl Default for RequestConfig

Implementation of Default trait for RequestConfig.

fn default() -> RequestConfig

Creates a new RequestConfig with default secure settings.

This constructor initializes the configuration with standard security limits suitable for most HTTP request parsing scenarios.

Returns

• Self - A new RequestConfig instance with default settings.

impl Display for RequestConfig

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

Formats the value using the given formatter.

impl From<RequestConfigData> for RequestConfig

Implementation of From trait for RequestConfig.

fn from(ctx: RequestConfigData) -> RequestConfig

Converts a RequestConfigData into a RequestConfig.

Arguments

• RequestConfigData - The wrapped context data.

Returns

• RequestConfig - The newly created context instance.

impl PartialEq for RequestConfig

Implementation of PartialEq trait for RequestConfig.

fn eq(&self, other: &RequestConfig) -> bool

Compares two RequestConfig instances for equality.

Arguments

• &self - The first RequestConfig instance.
• other - The second RequestConfig instance to compare.

Returns

• bool - true if the instances are equal, false otherwise.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RequestConfig

Implementation of Eq trait for RequestConfig.