Builder

rama::http::core::server::conn::http2

Struct Builder 

pub struct Builder { /* private fields */ }
Available on crate features http and http-full only.
Expand description

A configuration builder for HTTP/2 server connections.

Note: The default values of options are not considered stable. They are subject to change at any time.

Implementations§

§

impl Builder

pub fn new(exec: Executor) -> Builder

Create a new connection builder.

pub fn maybe_with_max_pending_accept_reset_streams( self, max: Option<usize>, ) -> Builder

Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent.

This will default to the default value set by the h2 crate. As of v0.4.0, it is 20.

See https://github.com/hyperium/hyper/issues/2877 for more information.

pub fn maybe_set_max_pending_accept_reset_streams( &mut self, max: Option<usize>, ) -> &mut Builder

Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent.

This will default to the default value set by the h2 crate. As of v0.4.0, it is 20.

See https://github.com/hyperium/hyper/issues/2877 for more information.

pub fn with_max_pending_accept_reset_streams(self, max: usize) -> Builder

Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent.

This will default to the default value set by the h2 crate. As of v0.4.0, it is 20.

See https://github.com/hyperium/hyper/issues/2877 for more information.

pub fn set_max_pending_accept_reset_streams( &mut self, max: usize, ) -> &mut Builder

Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent.

This will default to the default value set by the h2 crate. As of v0.4.0, it is 20.

See https://github.com/hyperium/hyper/issues/2877 for more information.

pub fn without_max_pending_accept_reset_streams(self) -> Builder

Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent.

This will default to the default value set by the h2 crate. As of v0.4.0, it is 20.

See https://github.com/hyperium/hyper/issues/2877 for more information.

pub fn unset_max_pending_accept_reset_streams(&mut self) -> &mut Builder

Configures the maximum number of pending reset streams allowed before a GOAWAY will be sent.

This will default to the default value set by the h2 crate. As of v0.4.0, it is 20.

See https://github.com/hyperium/hyper/issues/2877 for more information.

pub fn maybe_with_max_local_error_reset_streams( self, max: Option<usize>, ) -> Builder

Configures the maximum number of local reset streams allowed before a GOAWAY will be sent.

If not set, rama_http_core will use a default, currently of 1024.

If None is supplied, rama_http_core will not apply any limit. This is not advised, as it can potentially expose servers to DOS vulnerabilities.

See https://rustsec.org/advisories/RUSTSEC-2024-0003.html for more information.

pub fn maybe_set_max_local_error_reset_streams( &mut self, max: Option<usize>, ) -> &mut Builder

Configures the maximum number of local reset streams allowed before a GOAWAY will be sent.

If not set, rama_http_core will use a default, currently of 1024.

If None is supplied, rama_http_core will not apply any limit. This is not advised, as it can potentially expose servers to DOS vulnerabilities.

See https://rustsec.org/advisories/RUSTSEC-2024-0003.html for more information.

pub fn with_max_local_error_reset_streams(self, max: usize) -> Builder

Configures the maximum number of local reset streams allowed before a GOAWAY will be sent.

If not set, rama_http_core will use a default, currently of 1024.

If None is supplied, rama_http_core will not apply any limit. This is not advised, as it can potentially expose servers to DOS vulnerabilities.

See https://rustsec.org/advisories/RUSTSEC-2024-0003.html for more information.

pub fn set_max_local_error_reset_streams(&mut self, max: usize) -> &mut Builder

Configures the maximum number of local reset streams allowed before a GOAWAY will be sent.

If not set, rama_http_core will use a default, currently of 1024.

If None is supplied, rama_http_core will not apply any limit. This is not advised, as it can potentially expose servers to DOS vulnerabilities.

See https://rustsec.org/advisories/RUSTSEC-2024-0003.html for more information.

pub fn without_max_local_error_reset_streams(self) -> Builder

Configures the maximum number of local reset streams allowed before a GOAWAY will be sent.

If not set, rama_http_core will use a default, currently of 1024.

If None is supplied, rama_http_core will not apply any limit. This is not advised, as it can potentially expose servers to DOS vulnerabilities.

See https://rustsec.org/advisories/RUSTSEC-2024-0003.html for more information.

pub fn unset_max_local_error_reset_streams(&mut self) -> &mut Builder

Configures the maximum number of local reset streams allowed before a GOAWAY will be sent.

If not set, rama_http_core will use a default, currently of 1024.

If None is supplied, rama_http_core will not apply any limit. This is not advised, as it can potentially expose servers to DOS vulnerabilities.

See https://rustsec.org/advisories/RUSTSEC-2024-0003.html for more information.

pub fn with_initial_stream_window_size(self, sz: u32) -> Builder

Sets the SETTINGS_INITIAL_WINDOW_SIZE option for HTTP2 stream-level flow control.

If not set, rama_http_core will use a default.

pub fn set_initial_stream_window_size(&mut self, sz: u32) -> &mut Builder

Sets the SETTINGS_INITIAL_WINDOW_SIZE option for HTTP2 stream-level flow control.

If not set, rama_http_core will use a default.

pub fn with_initial_connection_window_size(self, sz: u32) -> Builder

Sets the max connection-level flow control for HTTP2.

If not set, rama_http_core will use a default.

pub fn set_initial_connection_window_size(&mut self, sz: u32) -> &mut Builder

Sets the max connection-level flow control for HTTP2.

If not set, rama_http_core will use a default.

pub fn with_adaptive_window(self, enabled: bool) -> Builder

Sets whether to use an adaptive flow control.

Enabling this will override the limits set in initial_stream_window_size and initial_connection_window_size.

pub fn set_adaptive_window(&mut self, enabled: bool) -> &mut Builder

Sets whether to use an adaptive flow control.

Enabling this will override the limits set in initial_stream_window_size and initial_connection_window_size.

pub fn with_max_frame_size(self, sz: u32) -> Builder

Sets the maximum frame size to use for HTTP2.

If not set, rama_http_core will use a default.

pub fn set_max_frame_size(&mut self, sz: u32) -> &mut Builder

Sets the maximum frame size to use for HTTP2.

If not set, rama_http_core will use a default.

pub fn maybe_with_max_concurrent_streams(self, max: Option<u32>) -> Builder

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is 200, but not part of the stability of rama_http_core. It could change in a future release. You are encouraged to set your own limit.

Passing None will remove any limit.

pub fn maybe_set_max_concurrent_streams( &mut self, max: Option<u32>, ) -> &mut Builder

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is 200, but not part of the stability of rama_http_core. It could change in a future release. You are encouraged to set your own limit.

Passing None will remove any limit.

pub fn with_max_concurrent_streams(self, max: u32) -> Builder

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is 200, but not part of the stability of rama_http_core. It could change in a future release. You are encouraged to set your own limit.

Passing None will remove any limit.

pub fn set_max_concurrent_streams(&mut self, max: u32) -> &mut Builder

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is 200, but not part of the stability of rama_http_core. It could change in a future release. You are encouraged to set your own limit.

Passing None will remove any limit.

pub fn without_max_concurrent_streams(self) -> Builder

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is 200, but not part of the stability of rama_http_core. It could change in a future release. You are encouraged to set your own limit.

Passing None will remove any limit.

pub fn unset_max_concurrent_streams(&mut self) -> &mut Builder

Sets the SETTINGS_MAX_CONCURRENT_STREAMS option for HTTP2 connections.

Default is 200, but not part of the stability of rama_http_core. It could change in a future release. You are encouraged to set your own limit.

Passing None will remove any limit.

pub fn maybe_with_keep_alive_interval( self, interval: Option<Duration>, ) -> Builder

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

pub fn maybe_set_keep_alive_interval( &mut self, interval: Option<Duration>, ) -> &mut Builder

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

pub fn with_keep_alive_interval(self, interval: Duration) -> Builder

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

pub fn set_keep_alive_interval(&mut self, interval: Duration) -> &mut Builder

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

pub fn without_keep_alive_interval(self) -> Builder

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

pub fn unset_keep_alive_interval(&mut self) -> &mut Builder

Sets an interval for HTTP2 Ping frames should be sent to keep a connection alive.

Pass None to disable HTTP2 keep-alive.

Default is currently disabled.

pub fn with_keep_alive_timeout(self, timeout: Duration) -> Builder

Sets a timeout for receiving an acknowledgement of the keep-alive ping.

If the ping is not acknowledged within the timeout, the connection will be closed. Does nothing if keep_alive_interval is disabled.

Default is 20 seconds.

pub fn set_keep_alive_timeout(&mut self, timeout: Duration) -> &mut Builder

Sets a timeout for receiving an acknowledgement of the keep-alive ping.

If the ping is not acknowledged within the timeout, the connection will be closed. Does nothing if keep_alive_interval is disabled.

Default is 20 seconds.

pub fn with_max_send_buf_size(self, max: u32) -> Builder

Set the maximum write buffer size for each HTTP/2 stream.

Default is currently ~400KB, but may change.

pub fn set_max_send_buf_size(&mut self, max: u32) -> &mut Builder

Set the maximum write buffer size for each HTTP/2 stream.

Default is currently ~400KB, but may change.

pub fn with_enable_connect_protocol(self) -> Builder

Enables the extended CONNECT protocol.

pub fn set_enable_connect_protocol(&mut self) -> &mut Builder

Enables the extended CONNECT protocol.

pub fn with_max_header_list_size(self, max: u32) -> Builder

Sets the max size of received header frames.

Default is currently 16KB, but can change.

pub fn set_max_header_list_size(&mut self, max: u32) -> &mut Builder

Sets the max size of received header frames.

Default is currently 16KB, but can change.

pub fn with_auto_date_header(self, enabled: bool) -> Builder

Set whether the date header should be included in HTTP responses.

Note that including the date header is recommended by RFC 7231.

Default is true.

pub fn set_auto_date_header(&mut self, enabled: bool) -> &mut Builder

Set whether the date header should be included in HTTP responses.

Note that including the date header is recommended by RFC 7231.

Default is true.

pub fn serve_connection<S, I>(&self, io: I, service: S) -> Connection<I, S> ⓘ
where S: HttpService<Incoming>, I: AsyncRead + AsyncWrite + Send + Unpin + ExtensionsMut + 'static,

Bind a connection together with a Service.

This returns a Future that must be polled in order for HTTP to be driven on the connection.

Trait Implementations§

§

impl Clone for Builder

§

fn clone(&self) -> Builder

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 Builder

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

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