h2_frame

An HTTP/2 frame encoder and decoder for Gleam.

Handles all standard HTTP/2 frame types as defined in RFC 9113: DATA, HEADERS, PRIORITY, RST_STREAM, SETTINGS, PUSH_PROMISE, PING, GOAWAY, WINDOW_UPDATE, and CONTINUATION. Unknown frame types are preserved rather than rejected.

Installation

gleam add h2_frame

Usage

Parsing

Parsing is done in two phases: first extract a raw frame from the buffer, then parse it.

import h2_frame

// Extract a single frame from a buffer (e.g. data read from a socket)
let assert Ok(#(frame_data, rest)) =
  h2_frame.extract_frame(buffer, max_frame_size)

// Parse the extracted frame
let assert Ok(frame) = h2_frame.decode_frame(frame_data)

Encoding

// Encode a settings frame
let assert Ok(frame) =
  h2_frame.encode_settings(ack: False, settings: [
    h2_frame.MaxConcurrentStreams(100),
    h2_frame.InitialWindowSize(65535),
  ])

// Encode a ping frame
let assert Ok(frame) =
  h2_frame.encode_ping(ack: False, data: <<1, 2, 3, 4, 5, 6, 7, 8>>)

Documentation

Full API documentation is available at https://hexdocs.pm/h2_frame.