Enum H3Event

pub enum H3Event {
    IncomingSettings {
        settings: Vec<(u64, u64)>,
    },
    IncomingHeaders(IncomingH3Headers),
    NewFlow {
        flow_id: u64,
        send: OutboundFrameSender,
        recv: InboundFrameStream,
    },
    ResetStream {
        stream_id: u64,
    },
    ConnectionError(Error),
    ConnectionShutdown(Option<H3ConnectionError>),
    BodyBytesReceived {
        stream_id: u64,
        num_bytes: u64,
        fin: bool,
    },
    StreamClosed {
        stream_id: u64,
    },
}

H3Events are produced by an H3Driver to describe HTTP/3 state updates.

Both ServerH3Driver and ClientH3Driver may extend this enum with endpoint-specific variants. The events must be consumed by users of the drivers, like a higher-level Server or Client controller.

Variants

IncomingSettings

A SETTINGS frame was received.

Fields

settings: Vec<(u64, u64)>

Raw HTTP/3 setting pairs, in the order received from the peer.

IncomingHeaders(IncomingH3Headers)

A HEADERS frame was received on the given stream. This is either a request or a response depending on the perspective of the H3Event receiver.

NewFlow

A DATAGRAM flow was created and associated with the given flow_id. This event is fired before a HEADERS event for CONNECT[-UDP] requests.

Fields

flow_id: u64

Flow ID of the new flow.

send: OutboundFrameSender

An OutboundFrameSender for transmitting datagrams to the peer.

recv: InboundFrameStream

An InboundFrameStream for receiving datagrams from the peer.

ResetStream

A RST_STREAM frame was seen on the given stream_id. The user of the driver should clean up any state allocated for this stream.

Fields

stream_id: u64

ConnectionError(Error)

The connection has irrecoverably errored and is shutting down.

ConnectionShutdown(Option<H3ConnectionError>)

The connection has been shutdown, optionally due to an H3ConnectionError.

BodyBytesReceived

Body data has been received over a stream.

Fields

stream_id: u64

Stream ID of the body data.

num_bytes: u64

Number of bytes received.

fin: bool

Whether the stream is finished and won’t yield any more data.

StreamClosed

The stream has been closed. This is used to signal stream closures that don’t result from RST_STREAM frames, unlike the H3Event::ResetStream variant.

Fields

stream_id: u64

Trait Implementations

impl Debug for H3Event

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

Formats the value using the given formatter.

impl From<H3Event> for ClientH3Event

fn from(ev: H3Event) -> Self

Converts to this type from the input type.

impl From<H3Event> for ServerH3Event

fn from(ev: H3Event) -> Self

Converts to this type from the input type.