Struct BoxedConnection 

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

Available on crate features http-backend and http and std only.

A Connection behind dynamic dispatch, for where one type has to carry any transport.

Its streams, futures and reservations are boxed as well.

Implementations

impl BoxedConnection

pub fn new<C>(connection: C) -> BoxedConnection

where C: ReserveBiStreams,

Trait Implementations

impl Clone for BoxedConnection

fn clone(&self) -> BoxedConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Connection for BoxedConnection

type SendStream = BoxedSendStream

type RecvStream = Box<dyn RecvStream>

type CloseLease = Box<dyn Sync + Send>

fn open_bi( &self, ) -> impl Future<Output = Result<(BoxedSendStream, Box<dyn RecvStream>), ConnectionError>> + Send

fn open_uni( &self, ) -> impl Future<Output = Result<BoxedSendStream, ConnectionError>> + Send

fn accept_bi( &self, ) -> impl Future<Output = Result<(BoxedSendStream, Box<dyn RecvStream>), ConnectionError>> + Send

Accept the next peer-initiated bidirectional stream. Queued incoming streams remain available after connection closure, before the terminal error.

fn accept_uni( &self, ) -> impl Future<Output = Result<Box<dyn RecvStream>, ConnectionError>> + Send

Accept the next peer-initiated unidirectional stream. Queued incoming streams remain available after connection closure, before the terminal error, so HTTP/3 can drain buffered control and QPACK data.

fn side(&self) -> Side

Which stream IDs are locally initiated. Must match the IDs the streams report.

fn handshake_confirmed( &self, ) -> impl Future<Output = Result<(), ConnectionError>> + Send

Application data can be sent without 0-RTT replay risk. Before resolving successfully, publish the negotiated Config::application_protocol in NegotiatedTlsParameters in the shared extensions.

fn is_handshake_confirmed(&self) -> bool

Whether Self::handshake_confirmed resolved successfully; stays true after closing.

fn close(&self, error_code: VarInt, reason: &[u8])

fn closed(&self) -> impl Future<Output = ConnectionError> + Send

fn close_reason(&self) -> Option<ConnectionError>

fn available_streams(&self, dir: Dir) -> u64

Locally initiated streams that can be opened now.

fn max_concurrent_streams(&self, dir: Dir) -> u64

Streams this endpoint allows the peer to have open at once.

fn remote_stream_limit(&self, dir: Dir) -> u64

Cumulative count of streams this endpoint allows the peer to open.

fn local_stream_limit(&self, dir: Dir) -> u64

Cumulative count of streams the peer allows this endpoint to open.

fn early_data(&self) -> EarlyData

Where this client’s early data stands.

fn qlog_control(&self) -> Option<ConnectionQlogControl>

The qlog sink HTTP/3 events are written to.

fn read_datagram( &self, ) -> impl Future<Output = Result<Bytes, ConnectionError>> + Send

Receive the next QUIC DATAGRAM payload. Dropping a pending future must not discard a datagram; HTTP/3 selects this future alongside other connection work.

fn max_datagram_size(&self) -> Option<usize>

fn datagram_receive_enabled(&self) -> bool

The peer may send QUIC DATAGRAM frames to this endpoint.

fn received_datagrams(&self) -> usize

Datagrams received and not yet taken by Self::read_datagram.

fn datagram_send_ready( &self, ) -> impl Future<Output = ()> + Send + 'static + use<>

Room on the datagram send queue, or the connection closed. Registered when called: create it before a send that may be refused as blocked and await it after the refusal.

fn close_lease(&self) -> Box<dyn Sync + Send>

Holds off this connection’s close at a graceful shutdown until dropped, so a tunnel can still send what it carries.

fn rtt(&self) -> Duration

Bounds how long a datagram waits for its request stream.

impl Debug for BoxedConnection

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

Formats the value using the given formatter.

impl ExtensionsRef for BoxedConnection

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl ReserveBiStreams for BoxedConnection

type Reservation = BoxedBiReservation<BoxedSendStream, Box<dyn RecvStream>>

fn try_reserve_bi( &self, ) -> Result<Option<<BoxedConnection as ReserveBiStreams>::Reservation>, ConnectionError>

None before the handshake completes or while credit is exhausted.

fn subscribe_bi_stream_budget(&self, listener: Weak<dyn ChangeListener>)

Notify listener when locally initiated bidirectional stream credit becomes available, the handshake completes, or the connection closes, until the listener is dropped. Acquiring or consuming a reservation need not notify listeners. Subscribe before trying to reserve credit to avoid missing a notification.