Struct HttpPeekConfig 

#[non_exhaustive]
pub struct HttpPeekConfig {
    pub timeout: Option<Duration>,
    pub timeout_policy: PeekTimeoutPolicy,
    pub max_http1_request_line_size: usize,
    pub read_buffer_size: usize,
    pub skipped_http1_methods: &'static [&'static str],
}

Available on crate feature net only.

Configuration used while detecting HTTP on a byte stream.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

timeout: Option<Duration>

timeout applied to the complete HTTP peek operation

timeout_policy: PeekTimeoutPolicy

policy applied when the timeout expires before HTTP detection reaches a definitive match or rejection

max_http1_request_line_size: usize

maximum number of bytes inspected for an HTTP/1 request-line

read_buffer_size: usize

maximum number of bytes requested per transport read

skipped_http1_methods: &'static [&'static str]

HTTP/1 method prefixes routed to the fallback before a delimiter.

Matching is case-sensitive and fail-fast, so PING also skips PINGX. Empty or invalid method tokens cannot match.

Implementations

impl HttpPeekConfig

pub fn new() -> HttpPeekConfig

Create an HTTP peek configuration using the defaults.

pub fn with_timeout_policy( self, timeout_policy: PeekTimeoutPolicy, ) -> HttpPeekConfig

Set how an inconclusive HTTP peek timeout is handled.

Defaults to PeekTimeoutPolicy::FailOpen. A definitive non-HTTP prefix remains a normal non-match under either policy.

pub fn set_timeout_policy( &mut self, timeout_policy: PeekTimeoutPolicy, ) -> &mut HttpPeekConfig

Set how an inconclusive HTTP peek timeout is handled.

Defaults to PeekTimeoutPolicy::FailOpen. A definitive non-HTTP prefix remains a normal non-match under either policy.

pub fn with_known_non_http_protocol_methods(self) -> HttpPeekConfig

Use KNOWN_NON_HTTP_PROTOCOL_METHODS as the skipped method list.

pub fn set_known_non_http_protocol_methods(&mut self) -> &mut HttpPeekConfig

Use KNOWN_NON_HTTP_PROTOCOL_METHODS as the skipped method list.

pub fn with_skipped_http1_methods( self, skipped_http1_methods: &'static [&'static str], ) -> HttpPeekConfig

Set HttpPeekConfig::skipped_http1_methods.

pub fn set_skipped_http1_methods( &mut self, skipped_http1_methods: &'static [&'static str], ) -> &mut HttpPeekConfig

Set HttpPeekConfig::skipped_http1_methods.

Trait Implementations

impl Clone for HttpPeekConfig

fn clone(&self) -> HttpPeekConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for HttpPeekConfig

impl Debug for HttpPeekConfig

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

Formats the value using the given formatter.

impl Default for HttpPeekConfig

fn default() -> HttpPeekConfig

Returns the “default value” for a type.

impl Eq for HttpPeekConfig

impl PartialEq for HttpPeekConfig

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for HttpPeekConfig