A protocol-agnostic, zero-buffer suite of Web Standard APIs for Elixir.
Most Elixir networking libraries buffer data into memory by default. Web is built for Zero-Buffer Streaming, ensuring your applications remain responsive and low-memory even when handling gigabytes of data.
By implementing WHATWG standards as Native Process-backed entities (:gen_statem), Web provides a consistent, predictable, and backpressure-aware interface for HTTP, TCP, and custom protocols.
If you’ve used the modern Web API in a browser, you already know how to use this library. We've mapped those standards to idiomatic Elixir.
defmodule GitHub do
use Web
def repositories(query \\ "elixir") do
# 1. Standard URL manipulation
url = URL.new("https://github.com/ghapi/search/repositories")
params =
URL.search_params(url)
|> URLSearchParams.set("q", query)
|> URLSearchParams.append("sort", "stars")
url = URL.search(url, URLSearchParams.to_string(params))
# 2. Construct a Request with automatic header inference
request = Request.new(url,
method: "GET",
headers: %{"Accept" => "application/vnd.github.v3+json"}
)
# 3. Fetch and stream the results lazily
fetch(request)
end
end
{:ok, response} = GitHub.repositories()
# Zero-buffer streaming: chunks are written to stdout as they arrive
response.body
|> Stream.take(5)
|> Enum.each(&IO.write/1)The source of every streaming pipeline. A ReadableStream is a managed process that provides data to consumers, handling Backpressure (throttling producers when consumers are slow), Locking (ensuring exclusive access), and Teeing (splitting streams for multiple consumers) in a zero-copy, process-safe way.
# Create a stream from any enumerable (List, File.stream, etc.)
stream = ReadableStream.from(["chunk1", "chunk2"])
# Split one stream into two independent branches (Zero-copy)
{branch_a, branch_b} = ReadableStream.tee(stream)
Task.start(fn -> Enum.each(branch_a, &process_data/1) end)
Task.start(fn -> Enum.each(branch_b, &log_data/1) end)Writable streams are endpoints for consuming data, supporting backpressure and lock management. Use them to write data from readable streams or directly from your application.
# Get a writable stream (for example, from a custom stream or a network response)
writable = WritableStream.new()
writer = WritableStream.get_writer(writable)
# Write chunks to the stream
:ok = WritableStreamDefaultWriter.write(writer, "hello ")
:ok = WritableStreamDefaultWriter.write(writer, "world!")
# Close and release
:ok = WritableStreamDefaultWriter.close(writer)
:ok = WritableStreamDefaultWriter.release_lock(writer)Transform streams allow you to process, modify, or filter data as it flows through a pipeline. They are ideal for tasks like compression, encryption, or counting bytes.
transform = TransformStream.new(%{
transform: fn chunk, controller, state ->
# Example: uppercase transformation
upper = String.upcase(IO.iodata_to_binary(chunk))
ReadableStreamDefaultController.enqueue(controller, upper)
{:ok, state}
end,
flush: fn controller, state ->
ReadableStreamDefaultController.close(controller)
{:ok, state}
end
})
# Pipe data through the transform
source = ReadableStream.from(["foo", "bar"])
WritableStream = transform.writable
ReadableStream = transform.readable
Enum.each(source, fn chunk ->
:ok = WritableStreamDefaultWriter.write(WritableStream.get_writer(WritableStream), chunk)
end)
:ok = WritableStreamDefaultWriter.close(WritableStream.get_writer(WritableStream))
# Collect transformed output
Enum.to_list(ReadableStream)
# => ["FOO", "BAR"]First-class containers for network data with high-level factories and standard body readers.
# High-level factories for common responses
res = Response.json(%{status: "ok"})
redirect = Response.redirect("https://elixir-lang.org")
# Automatic status and body readers
if res.ok do
{:ok, data} = Response.json(res) # Terminal consumer
end
# Multi-protocol support (HTTP/TCP)
req = Request.new("tcp://localhost:8080", method: "SEND", body: "ping")Pure, immutable URL parsing and ordered query parameter management.
# URL parsing
url = URL.new("https://user:pass@example.com:8080/p/a/t/h?query=string#hash")
url.port # => 8080
# Params management
params = URLSearchParams.new("foo=bar&foo=baz")
URLSearchParams.get_all(params, "foo") # => ["bar", "baz"]Case-insensitive, enumerable header management with built-in protection against credential leakage.
headers = Headers.new(%{"Content-Type" => "text/plain"})
headers = Headers.append(headers, "Set-Cookie", "id=123")
# Automatic Redaction in logs/IEx
IO.inspect(Headers.set(headers, "Authorization", "Bearer secret"))
# => %Web.Headers{"authorization" => "[REDACTED]", ...}A unified mechanism for cancelling any asynchronous operation.
controller = AbortController.new()
signal = AbortController.signal(controller)
# Pass the signal to a fetch or any async task
Task.start(fn ->
# Logic that listens for AbortSignal.aborted?(signal)
end)
# Trigger cancellation
AbortController.abort(controller, "Too slow!")Immutable data types for efficient binary handling without premature memory flattening.
# Build a Blob from multiple parts lazily
blob = Blob.new(["part1", some_other_blob], type: "text/plain")
# Standard byte views
buffer = ArrayBuffer.new(1024)
view = Uint8Array.new(buffer, 10, 100) # Offset 10, Length 100- ⚡ Zero-Buffer Streaming: Data flows directly from the socket to your logic.
- ⚖️ Native Backpressure: Sources automatically throttle when your application is busy.
- 👯 Spec-Compliant Cloning: Branch body streams so multiple consumers can read the same data.
- 🔄 Redirect-Safe:
307and308redirects preserve streaming bodies automatically. - 🧩 Protocol-Agnostic: Core types support HTTP, TCP, and custom dispatchers.
- 🛡 Security-First: Sensitive headers are redacted by default in terminal output.
Reliability is a core requirement. Web features exhaustive coverage for stream transitions, body consumption, and redirect handling.
mix test --coverBuilt with ❤️ for the Elixir community.