Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
toolkit-zero
A feature-selective Rust utility crate. Declare only the modules your project requires via Cargo feature flags; each feature compiles exclusively the code it depends on, with no extraneous overhead.
1. Overview
- Plain routes
- JSON body routes
- Query parameter routes
- Shared state
- Combining state with body / query
- Encrypted routes
- Serving the server
- Graceful shutdown
- Background server
- Building responses
- Sync handlers
#[mechanism]attribute macro
- Creating a client
- Plain requests
- JSON body requests
- Query parameter requests
- Encrypted requests
- Sync vs async sends
#[request]attribute macro
- CLI launch options
- Rust API — launch functions
- Target variants
- Programmatic control — BrowserHandle
- TabTarget
- ThemeMode
- Downloads panel
Overview
toolkit-zero follows a strict zero-overhead model: only the features you declare are compiled into your binary. Every module is isolated behind an independent feature gate; enabling a feature introduces exactly the dependencies that module requires — nothing more.
Feature flags
| Feature | What it enables | Module exposed |
|---|---|---|
serialization |
ChaCha20-Poly1305 authenticated encryption — seal any struct to opaque bytes and back | toolkit_zero::serialization |
socket-server |
Typed HTTP server builder (includes serialization) |
toolkit_zero::socket::server |
socket-client |
Typed HTTP client builder (includes serialization) |
toolkit_zero::socket::client |
socket |
Both socket-server and socket-client |
both socket sub-modules |
location-browser |
Browser-based geolocation (includes socket-server) |
toolkit_zero::location::browser |
location |
Alias for location-browser |
toolkit_zero::location |
enc-timelock-keygen-now |
Time-lock key derivation from the system clock | toolkit_zero::encryption::timelock |
enc-timelock-keygen-input |
Time-lock key derivation from a caller-supplied time | toolkit_zero::encryption::timelock |
enc-timelock-async-keygen-now |
Async variant of enc-timelock-keygen-now |
toolkit_zero::encryption::timelock |
enc-timelock-async-keygen-input |
Async variant of enc-timelock-keygen-input |
toolkit_zero::encryption::timelock |
encryption |
All four enc-timelock-* features |
toolkit_zero::encryption::timelock |
dependency-graph-build |
Attach a normalised dependency-graph snapshot at build time | toolkit_zero::dependency_graph::build |
dependency-graph-capture |
Read the embedded snapshot at runtime | toolkit_zero::dependency_graph::capture |
browser |
Full-featured WebKit browser window + programmatic API + parallel downloader | toolkit_zero::browser |
backend-deps |
Re-exports all third-party deps used by each active module | *::backend_deps |
Add with cargo add:
# Serialization (ChaCha20-Poly1305) only
# HTTP server only
# HTTP client only
# Both sides
# Geolocation (pulls in socket-server automatically)
# Full time-lock encryption suite
# Attach build-time fingerprint in build.rs
# Read build-time fingerprint at runtime
# Browser (WebKit window + downloads + programmatic API)
# Re-export deps alongside socket-server
Serialization
Feature: serialization
ChaCha20-Poly1305 authenticated encryption transforms any bincode-encodable value into an opaque, authenticated byte blob. Without the correct key the ciphertext cannot be decrypted; any bit-level tampering is detected and rejected by the Poly1305 tag.
Keys are moved into seal/open and wrapped in Zeroizing<String> internally, wiping them from memory on drop.
Entry points:
| Function / Macro | Direction |
|---|---|
toolkit_zero::serialization::seal(&value, key) |
struct → Vec<u8> |
toolkit_zero::serialization::open::<T>(&bytes, key) |
Vec<u8> → struct |
#[serializable] |
derive Encode+Decode + inject .seal() / ::open() |
#[serialize(...)] |
inline seal to a variable or file |
#[deserialize(...)] |
inline open from a variable blob or file |
key is Option<String>. Pass None to use the built-in default key.
Types must derive Encode and Decode:
use ;
// With the default key
let cfg = Config ;
let blob = seal.unwrap;
let back: Config = open.unwrap;
assert_eq!;
// With a custom shared key (moved in, zeroized on drop)
let blob2 = seal.unwrap;
let back2: Config = open.unwrap;
assert_eq!;
#[serializable] — inject methods directly on a struct or enum:
use serializable;
let c = Config ;
let blob = c.seal.unwrap;
let back = open.unwrap;
// Per-field encrypted helpers:
// → Creds::seal_password(&self), Creds::open_password(bytes)
#[serialize] / #[deserialize] — inline seal/open as statements:
use ;
// Variable mode
// expands to: let blob: Vec<u8> = seal(&cfg, Some(my_key))?;
// File write mode
fn _
// expands to: fs::write("config.bin", seal(&cfg, None)?)?;
// Deserialize from file
// expands to: let cfg: Config = open::<Config>(&fs::read("config.bin")?, Some(my_key))?;
Socket — server
Feature: socket-server
A fluent, type-safe builder API for declaring and serving HTTP routes. Each route originates from a ServerMechanism, is optionally enriched with JSON body, query parameter, or shared-state expectations, and is finalised via .onconnect(handler). Registered routes are served through a single .await call on the Server.
Plain routes
No body and no query. The handler receives nothing.
use ;
let mut server = default;
server.mechanism;
All standard HTTP methods are available: get, post, put, delete, patch, head, and options.
JSON body routes
Call .json::<T>() on the mechanism. The request body is deserialised as T before the handler is invoked; the handler always receives a validated, typed value. T must implement serde::Deserialize. A missing or malformed body automatically yields a 400 Bad Request response.
use Deserialize;
use ;
let mut server = default;
server.mechanism;
Query parameter routes
Call .query::<T>() on the mechanism. Incoming query parameters are deserialised as T before the handler is invoked; the handler always receives a validated, typed value. T must implement serde::Deserialize.
URL shape the server expects:
GET /search?q=hello&page=2
Each field of T maps to one key=value pair. Nested structs are not supported
by serde_urlencoded; keep query types flat.
use Deserialize;
use ;
let mut server = default;
server.mechanism;
Missing or malformed query parameters cause the server to return 400 Bad Request
before the handler is invoked.
Shared state
Call .state(value) on the mechanism. A cloned instance of the state is provided to each request handler. The state type must satisfy Clone + Send + Sync + 'static. Wrap mutable shared state in Arc<Mutex<_>> or Arc<RwLock<_>>.
use ;
use Serialize;
use ;
let store: = new;
let mut server = default;
server.mechanism;
Combining state with body / query
State may be combined with a body or query expectation. The call order of .state() and .json() / .query() is not significant; the handler always receives (state: S, body_or_query: T).
use ;
use ;
use ;
let store: = new;
let mut server = default;
server.mechanism;
Encrypted routes
Call .encryption::<T>(key) (body) or .encrypted_query::<T>(key) (query) on the mechanism. Provide a SerializationKey::Default (built-in key) or SerializationKey::Value("your-key") (custom key).
Before the handler is called, the body or query is decrypted (ChaCha20-Poly1305) using the supplied key. A wrong key, mismatched secret, or corrupt payload returns 403 Forbidden without ever reaching the handler. The T the closure receives is always a trusted, fully-decrypted value.
T must implement bincode::Decode<()>.
use ;
use SerializationKey;
use ;
let mut server = default;
server.mechanism;
For encrypted query parameters, the client sends ?data=<base64url> where the value is URL-safe base64 of the ChaCha20-Poly1305-sealed struct bytes.
Serving the server
// Bind to a specific address — runs until the process exits
server.serve.await;
Note: Routes are evaluated in registration order — the first matching route wins.
serve(),serve_with_graceful_shutdown(), andserve_from_listener()all panic immediately if called on aServerwith no routes registered.
Graceful shutdown
use oneshot;
let = ;
// Shut down later by calling: tx.send(()).ok();
server.serve_with_graceful_shutdown.await;
To use an OS-assigned port (e.g. to know the port before the server starts):
use TcpListener;
use oneshot;
let listener = bind.await?;
let port = listener.local_addr?.port;
let = ;
server.serve_from_listener.await;
Background server
Call serve_managed(addr) instead of serve(addr) to get a BackgroundServer handle.
The server starts immediately; the handle lets you inspect and mutate the running instance:
use ;
use Serialize;
async
| Method | Behaviour |
|---|---|
bg.addr() |
Returns the current bind address |
bg.mechanism(route).await |
Inserts a route into the live server — no restart, no port gap |
bg.rebind(addr).await |
Gracefully drains in-flight requests, then restarts on the new address |
bg.stop().await |
Sends the shutdown signal and awaits the background task |
All routes registered before serve_managed and those added via bg.mechanism are
automatically carried over when rebind is called.
Building responses
Use the reply! macro:
| Expression | Result |
|---|---|
reply!() |
200 OK with empty body |
reply!(json => value) |
200 OK with JSON-serialised body |
reply!(json => value, status => Status::Created) |
201 Created with JSON body |
reply!(message => my_reply_value, status => Status::NoContent) |
custom status on any Reply value |
reply!(sealed => value) |
200 OK with ChaCha20-Poly1305-sealed body (application/octet-stream) |
reply!(sealed => value, key => SerializationKey::Value("k")) |
sealed with explicit key |
Status re-exports the most common HTTP status codes as named variants (Status::Ok, Status::Created, Status::NoContent, Status::BadRequest, Status::Forbidden, Status::NotFound, Status::InternalServerError).
Sync handlers
Every route finaliser (onconnect) provides an unsafe blocking counterpart, onconnect_sync, for cases where an existing synchronous API cannot readily be made asynchronous. This variant is not recommended for production traffic.
use ;
let mut server = default;
// SAFETY: handler is fast; no shared mutable state; backpressure applied externally
unsafe
unsafe is required because onconnect_sync dispatches work to Tokio's blocking thread pool, which carries important caveats:
- The pool limits live OS threads to 512 (default), but the waiting-task queue is unbounded. Under sustained traffic, queued tasks can accumulate without bound, risking out-of-memory conditions or severe latency before any task executes.
- Panics inside the handler are silently converted to a
500 Internal Server Errorresponse, masking runtime errors. - Handlers that hold a lock (e.g.
Arc<Mutex<_>>) can stall the thread pool indefinitely under contention from concurrent blocking tasks.
onconnect_sync is available on every builder variant: plain, .json, .query, .state, and their combinations. All have identical safety requirements.
#[mechanism] attribute macro
The #[mechanism] attribute is a concise alternative to the builder calls above. It replaces the decorated async fn in-place with the equivalent server.mechanism(…) statement — no separate registration step required.
use ;
use ;
use ;
async
Supported forms:
| Attribute | fn parameters |
|---|---|
#[mechanism(server, METHOD, "/path")] |
() |
#[mechanism(server, METHOD, "/path", json)] |
(body: T) |
#[mechanism(server, METHOD, "/path", query)] |
(params: T) |
#[mechanism(server, METHOD, "/path", encrypted(key))] |
(body: T) |
#[mechanism(server, METHOD, "/path", encrypted_query(key))] |
(params: T) |
#[mechanism(server, METHOD, "/path", state(expr))] |
(state: S) |
#[mechanism(server, METHOD, "/path", state(expr), json)] |
(state: S, body: T) |
#[mechanism(server, METHOD, "/path", state(expr), query)] |
(state: S, params: T) |
#[mechanism(server, METHOD, "/path", state(expr), encrypted(key))] |
(state: S, body: T) |
#[mechanism(server, METHOD, "/path", state(expr), encrypted_query(key))] |
(state: S, params: T) |
The keywords after the path (json, query, state, encrypted, encrypted_query) may appear in any order.
Socket — client
Feature: socket-client
A fluent, type-safe builder API for issuing HTTP requests. Construct a Client from a Target, select an HTTP method, optionally attach a body or query parameters, and call .send().await (async) or .send_sync() (blocking).
Creating a client
use ;
// Async-only — safe to create inside #[tokio::main]
let client = new_async;
// Sync-only — must be created before entering any async runtime
let client = new_sync;
// Both async and blocking — must be created before entering any async runtime
let client = new;
// Remote target
let client = new_async;
| Constructor | .send() async |
.send_sync() blocking |
Safe inside #[tokio::main] |
|---|---|---|---|
Client::new_async(target) |
✓ | ✗ — panics at call site | ✓ |
Client::new_sync(target) |
✗ — panics at call site | ✓ | ✗ — panics at construction |
Client::new(target) |
✓ | ✓ | ✗ — panics at construction |
Why
Client::new()andClient::new_sync()panic inside an async context:reqwest::blocking::Clientcreates its own single-threaded Tokio runtime internally. Tokio does not allow a runtime to start while another is already running on the same thread.Client::new()proactively detects this viatokio::runtime::Handle::try_current()and panics at construction time with an actionable message before any field is initialised.Client::new_sync()fails the same way throughreqwestduring construction.Guidance:
- Async programs (
#[tokio::main]) — useClient::new_async().- Synchronous programs with no runtime — use
Client::new_sync()orClient::new().- Programs combining a synchronous entry point with a manual
tokio::Runtime— construct theClientbefore starting the runtime.
Plain requests
use Deserialize;
// Async
let item: Item = client.get.send.await?;
// Sync
let item: Item = client.get.send_sync?;
All standard HTTP methods are available: get, post, put, delete, patch, head, and options.
JSON body requests
Attach a request body with .json(value). value must implement serde::Serialize; the response is deserialised as R: serde::Deserialize.
use ;
let created: Item = client
.post
.json
.send
.await?;
Query parameter requests
Attach query parameters with .query(value). value must implement
serde::Serialize; the fields are serialised by serde_urlencoded and
appended to the request URL as ?key=value&....
URL the client will send:
GET /items?status=active&page=1
use ;
// Sends: GET /items?status=active&page=1
let items: = client
.get
.query
.send
.await?;
URL parameter ordering follows struct field declaration order. Nested structs are not supported by serde_urlencoded; keep query types flat.
Encrypted requests
Attach a ChaCha20-Poly1305-sealed body with .encryption(value, key). The body is sealed prior to transmission; the response bytes are unsealed automatically. Both the request (T) and response (R) use bincode encoding: T must implement bincode::Encode and R must implement bincode::Decode<().
use ;
use SerializationKey;
use ClientError;
let resp: Resp = client
.post
.encryption
.send
.await?;
For encrypted query parameters, use .encrypted_query(value, key). The params are sealed (ChaCha20-Poly1305) and sent as ?data=<base64url>.
let resp: Resp = client
.get
.encrypted_query
.send
.await?;
Both .send() and .send_sync() are available on encrypted builders, returning Result<R, ClientError>.
Sync vs async sends
| Method | Blocks the thread | Requires constructor |
|---|---|---|
.send().await |
No | Client::new_async() or Client::new() |
.send_sync() |
Yes | Client::new_sync() or Client::new() |
Using the wrong variant panics at the call site with an explicit message pointing to the correct constructor:
- Calling
.send()on anew_sync()client →"Client was created with new_sync() — call new_async() or new() to use async sends" - Calling
.send_sync()on anew_async()client →"Client was created with new_async() — call new_sync() or new() to use sync sends"
These call-site panics are distinct from the construction-time panic that Client::new() (and Client::new_sync()) raises when constructed inside an active Tokio runtime — see Creating a client.
#[request] attribute macro
The #[request] attribute is a concise alternative to the builder calls above. It replaces the decorated fn in-place with a let binding that performs the HTTP request — no separate variable declaration required. The function name becomes the binding name; the return type becomes R in the .send::<R>() turbofish. The function body is discarded.
use ;
use ;
async
Supported forms:
| Attribute | Generated call | Error type from ? |
|---|---|---|
#[request(client, METHOD, "/path", async)] |
.send::<R>().await? |
reqwest::Error |
#[request(client, METHOD, "/path", sync)] |
.send_sync::<R>()? |
reqwest::Error |
#[request(client, METHOD, "/path", json(expr), async|sync)] |
.json(expr).send::<R>() |
reqwest::Error |
#[request(client, METHOD, "/path", query(expr), async|sync)] |
.query(expr).send::<R>() |
reqwest::Error |
#[request(client, METHOD, "/path", encrypted(body, key), async|sync)] |
.encryption(body, key).send::<R>() |
ClientError |
#[request(client, METHOD, "/path", encrypted_query(params, key), async|sync)] |
.encrypted_query(params, key).send::<R>() |
ClientError |
The return type annotation on the fn is required — omitting it is a compile error.
Location
Feature: location (or location-browser)
Acquires the device's geographic coordinates by opening a locally served consent page in the system default browser. The browser requests location permission through the standard Web Geolocation API; on approval, the coordinates are submitted to the local HTTP server. The server shuts itself down once a result is received and returns the data to the caller.
No external services are contacted. All network activity is confined to 127.0.0.1.
Blocking usage
Compatible with both synchronous entry points and active Tokio runtimes. When invoked within an existing runtime, an OS thread is spawned to avoid nesting runtimes.
use ;
match __location__
Async usage
Recommended when executing within an active Tokio runtime — eliminates the OS thread spawn required by the blocking variant.
use ;
async
#[browser] attribute macro
The #[browser] macro is a concise alternative to calling __location__ /
__location_async__ directly. It replaces the decorated fn item with an
inline location-capture statement. The function name becomes the binding;
the PageTemplate is built from the macro arguments. A ? propagates any
LocationError to the enclosing function.
All arguments are optional and may appear in any order:
| Argument | Type | Notes |
|---|---|---|
sync |
flag | Use blocking __location__; default is __location_async__().await |
tickbox |
flag | Use PageTemplate::Tickbox; incompatible with html |
title = "…" |
string literal | Tab/heading title for Default or Tickbox |
body = "…" |
string literal | Body paragraph text |
consent = "…" |
string literal | Checkbox label (Tickbox only) |
html = "…" |
string literal | PageTemplate::Custom; mutually exclusive with all other template args |
use ;
// Async, Default template — all built-in text
async
// Async, Tickbox with consent text
async
// Async, completely custom HTML page
async
// Blocking, custom title
Page templates
PageTemplate controls what the user sees in the browser.
| Variant | Description |
|---|---|
PageTemplate::Default { title, body_text } |
Clean single-button consent page. Both fields are Option<String> and fall back to built-in text when None. |
PageTemplate::Tickbox { title, body_text, consent_text } |
Same as Default but adds a checkbox the user must tick before the button activates. |
PageTemplate::Custom(html) |
Fully custom HTML string. Place exactly one {} where the capture button should appear; the required JavaScript is injected automatically. |
use ;
// Custom title only
let _data = __location__;
// Tick-box consent
let _data = __location__;
// Fully custom HTML
let html = r#"<!DOCTYPE html>
<html><body>
<h1>Grant access</h1>
{}
</body></html>"#;
let _data = __location__;
LocationData fields
| Field | Type | Description |
|---|---|---|
latitude |
f64 |
Decimal degrees (WGS 84) |
longitude |
f64 |
Decimal degrees (WGS 84) |
accuracy |
f64 |
Horizontal accuracy in metres (95 % confidence) |
altitude |
Option<f64> |
Metres above WGS 84 ellipsoid, if available |
altitude_accuracy |
Option<f64> |
Accuracy of altitude in metres, if available |
heading |
Option<f64> |
Degrees clockwise from true north [0, 360), or None if stationary |
speed |
Option<f64> |
Ground speed in m/s, or None if unavailable |
timestamp_ms |
f64 |
Browser Unix timestamp in milliseconds |
LocationError variants
| Variant | Cause |
|---|---|
PermissionDenied |
User denied the browser's location permission prompt |
PositionUnavailable |
Device cannot determine its position |
Timeout |
No fix within the browser's built-in 30 s timeout |
ServerError |
Failed to start the local HTTP server or Tokio runtime |
Encryption — Timelock
Feature: encryption (or any enc-timelock-* sub-feature)
Derives a deterministic 32-byte time-locked key through a three-pass, memory-hard KDF chain:
Argon2id (pass 1) → scrypt (pass 2) → Argon2id (pass 3)
The key is only reproducible at the right time with the right salts. Paired with a passphrase (joint KDF), the search space becomes time-window × passphrase-space — extremely expensive to brute-force.
Timelock features
| Feature | Sync/Async | Entry point | Path |
|---|---|---|---|
enc-timelock-keygen-input |
sync | timelock(…, None) |
Encryption — derive from explicit time |
enc-timelock-keygen-now |
sync | timelock(…, Some(p)) |
Decryption — derive from system clock + header |
enc-timelock-async-keygen-input |
async | timelock_async(…, None) |
Async encryption |
enc-timelock-async-keygen-now |
async | timelock_async(…, Some(p)) |
Async decryption |
encryption |
both | both entry points | All four paths |
KDF presets
KdfPreset provides named parameter sets calibrated per platform:
| Preset | Peak RAM | Platform / intended use |
|---|---|---|
Fast / FastX86 |
~128 MiB | Cross-platform / x86-64 dev & CI |
FastArm |
~256 MiB | Linux ARM64 dev & CI |
FastMac |
~512 MiB | macOS (Apple Silicon) dev & CI |
Balanced / BalancedX86 |
~512 MiB | Cross-platform / x86-64 production |
BalancedArm |
~512 MiB | Linux ARM64 production |
BalancedMac |
~1 GiB | macOS (Apple Silicon) production |
Paranoid / ParanoidX86 / ParanoidArm |
~768 MiB | Cross-platform / x86-64 / ARM64 max security |
ParanoidMac |
~3 GiB | macOS max security (requires 8+ GiB unified memory) |
Custom(KdfParams) |
user-defined | Fully manual — tune to your hardware |
Timelock usage
use *;
// ── Encryption side ── caller sets the unlock time ─────────────────────────
let salts = generate;
let kdf = BalancedMac.params; // ~2 s on M2
let at = new.unwrap;
// params = None → _at (encryption) path
let enc_key = timelock.unwrap;
// Pack all settings — including salts and KDF params — into a self-contained
// header. Salts and KDF params are not secret; store the header in plaintext
// alongside the ciphertext so the decryption side can reconstruct the key.
let header = pack;
// ── Decryption side ── re-derives from the live clock ───────────────────────
// Load header from ciphertext; call at 14:30 local time.
// params = Some(header) → _now (decryption) path
let dec_key = timelock.unwrap;
assert_eq!;
For async usage replace timelock with timelock_async and .await the result.
All arguments are taken by value. Requires the matching enc-timelock-async-keygen-*
feature(s).
Dependency Graph — BuildTimeFingerprint
Features: dependency-graph-build · dependency-graph-capture
BuildTimeFingerprint attaches a normalised, deterministic snapshot of the build environment to the compiled binary. The snapshot is written to $OUT_DIR/fingerprint.json at compile time and embedded via include_str!; no runtime I/O is required.
The two features are intentionally independent so that each can be declared in the appropriate Cargo.toml section.
Sections captured
| Section | Contents |
|---|---|
package |
Crate name + version |
build |
Profile, opt-level, target triple, rustc version, active feature flags |
deps |
Full normalised cargo metadata graph — sorted, no absolute paths |
cargo_lock_sha256 |
SHA-256 of Cargo.lock (comment lines stripped) |
source |
SHA-256 of every .rs file under src/ |
Setup
[]
= { = ["dependency-graph-capture"] }
[]
= { = ["dependency-graph-build"] }
build.rs:
BuildTimeFingerprint usage
Embed and read the snapshot in your binary:
use capture;
const BUILD_TIME_FINGERPRINT: &str = include_str!;
BuildTimeFingerprintData fields:
| Field | Type | Description |
|---|---|---|
package.name |
String |
Crate name |
package.version |
String |
Crate version |
build.profile |
String |
"debug" / "release" / … |
build.opt_level |
String |
"0" – "3" / "s" / "z" |
build.target |
String |
Target triple |
build.rustc_version |
String |
Full rustc --version string |
build.features |
Vec<String> |
Sorted active feature names of the crate being built |
cargo_lock_sha256 |
String |
Hex SHA-256 of Cargo.lock |
source |
BTreeMap<String, String> |
path → "sha256:<hex>" per .rs file |
deps |
serde_json::Value |
Full normalised cargo metadata graph |
Debug export
generate_fingerprint(true) (or the standalone export(true)) writes a pretty-printed fingerprint.json alongside the crate's Cargo.toml for local inspection. This file is distinct from the compact version written to $OUT_DIR; the binary always embeds the $OUT_DIR copy.
Passing true to generate_fingerprint only runs cargo metadata once, which is more efficient than calling generate_fingerprint(false) + export(true) separately.
Add
fingerprint.jsonto.gitignore. The exported file contains the full dependency graph, per-file source hashes, target triple, and compiler version. Although the contents are not secret, committing the file adds repository noise and may expose build-environment details beyond what is intended.
#[dependencies] attribute macro
The #[dependencies] macro is a concise alternative to the include_str! + capture::parse() boilerplate. It requires the dependency-graph-capture feature.
Apply it to an empty fn inside a function body; the function name becomes the let binding:
use dependencies;
| Form | Result type | Propagates ? |
|---|---|---|
#[dependencies] |
BuildTimeFingerprintData |
yes |
#[dependencies(bytes)] |
&'static [u8] |
no |
Risks and considerations
| Concern | Detail |
|---|---|
| Not tamper-proof | The fingerprint is embedded as plain text in the binary's read-only data section. Anyone with access to the binary can read it. It is informational, not a security boundary. |
| Export file exposure | export(true) writes fingerprint.json to the crate root. Add it to .gitignore to prevent accidental commits. |
| Build-time overhead | cargo metadata runs on every rebuild. The cargo:rerun-if-changed directives restrict this to changes in src/, Cargo.toml, or Cargo.lock — unchanged builds do not re-run. |
| Feature capture scope | build.features captures the active features of the crate being built, not toolkit-zero's own features. |
| Absolute-path stripping | workspace_root, manifest_path, src_path, path, and other machine-specific fields are removed from cargo metadata output. The fingerprint is stable across different machines and checkout locations. |
| Compile-time only | The snapshot reflects the build environment at compile time. It does not update at runtime. |
Backend deps
Feature: backend-deps
When combined with any other feature, backend-deps appends a backend_deps sub-module to each active module. Each such sub-module re-exports (via pub use) every third-party crate used internally by the parent module, allowing downstream crates to access those dependencies without separate Cargo.toml declarations.
| Module | Path | Re-exports |
|---|---|---|
serialization |
toolkit_zero::serialization::backend_deps |
bincode, base64, zeroize |
socket (server side) |
toolkit_zero::socket::backend_deps |
bincode, base64, serde, tokio, log, bytes, serde_urlencoded, hyper, hyper_util, http, http_body_util |
socket (client side) |
toolkit_zero::socket::backend_deps |
bincode, base64, serde, tokio, log, reqwest |
location |
toolkit_zero::location::backend_deps |
tokio, serde, webbrowser, rand |
encryption (timelock) |
toolkit_zero::encryption::timelock::backend_deps |
argon2, scrypt, zeroize, chrono, rand; tokio (async variants only) |
dependency_graph |
toolkit_zero::dependency_graph::backend_deps |
serde_json; sha2 (build side only) |
Each re-export is individually gated on its parent feature; only the dependencies that are currently compiled appear in backend_deps. Enabling backend-deps without any other feature compiles successfully but exposes no symbols.
# Example: socket-server + dep re-exports
= { = ["socket-server", "backend-deps"] }
Then in your code:
// Access hyper directly through toolkit-zero
use hyper;
// Access bincode through serialization
use bincode;
Browser — duct-tape
Feature: browser
duct-tape is a full-featured, WebKit-native browser window built on iced (GPU-accelerated UI) and wry (cross-platform WebView). It ships as a standalone binary (duct-tape) and as a fully programmable Rust library API, making it trivial to embed a production-grade browser into any Rust application.
The name reflects the philosophy: high-performance plumbing assembled from best-in-class components, with our own parallel download engine layered on top where the platform would otherwise bottleneck you.
Native WebKit — zero rendering overhead
duct-tape delegates all page rendering to the platform's own WebKit engine:
| Platform | Engine | Notes |
|---|---|---|
| macOS / iOS | WebKit (WKWebView) |
Same engine as Safari; GPU-composited, Metal-backed |
| Linux | WebKitGTK | Full WebKit2 feature set |
| Windows | WebView2 (Chromium) | Edge's embedded rendering engine |
There is no Electron, no embedded Chromium, no extra process: the OS WebView is embedded directly inside the iced window via raw window handle. This means:
- Sub-millisecond page-layout and compositing (platform compositor handles it)
- Zero additional memory overhead for the renderer — the OS engine is already in RAM
- Full hardware acceleration — CSS transitions, WebGL, Canvas, video all run at native speed
- Every future platform WebKit security patch and performance improvement is inherited automatically, with no crate update required
The iced layer handles only the chrome (tabs, address bar, loading indicator, panels). It never touches the rendered web content.
Custom parallel download engine
By default, WebKit downloads files over a single TCP connection. duct-tape intercepts every download before WebKit touches it, cancels the native transfer, and routes it through our own parallel engine built on reqwest.
How it works
- HEAD request — probes
Content-LengthandAccept-Ranges: bytesheaders. - Threshold check — files below 4 MiB use a single streaming connection (HEAD overhead is not worth it).
- Byte-range splitting — files ≥ 4 MiB are divided into 8 equal-size chunks. Each chunk is fetched with its own
Range: bytes=X-YHTTP request, in parallel, on separate TCP connections. - Streaming write — each chunk streams directly to its slice of the output file via
.chunk()iteration (no full-chunk buffer). Memory usage stays flat regardless of file size. - Atomic rename — while downloading, the file lives at
<name>.tkz(preventing accidental opens). On completion it is renamed to the final path atomically. - Fallback — servers without
Accept-Rangesfall back to a single streaming connection automatically.
Performance comparison
| Scenario | Single-connection (browser default) | duct-tape (8 chunks) |
|---|---|---|
| Fast CDN, per-connection rate limit (e.g. 10 MB/s) | 10 MB/s | ~80 MB/s (8× limit) |
| High-latency connection (100 ms RTT) | Limited by slow-start TCP window | 8 windows open in parallel; latency paid once |
| Local LAN / no rate limit | Near line-speed | Same or slightly faster (concurrent window ramp) |
Server without Accept-Ranges |
Line rate | Graceful single-connection fallback |
In real-world benchmarks on CDN-hosted files (GitHub releases, package registries, etc.) duct-tape consistently achieves 3–8× higher throughput than a single-connection download.
Download resilience — stash and resume
Every in-flight download is persisted to a stash file (~/toolkit-zero/.browser-stash) the moment it starts. If the browser is closed mid-download the stash is read on the next launch and all interrupted transfers are automatically restarted from the beginning (byte-range resume is attempted for partially-written .tkz files).
Progress reporting
Progress flows from eight concurrent background tokio tasks through a process-global Mutex<Vec<ProgressUpdate>> queue. The iced Tick handler drains the queue every 16 ms (while downloads are active), applying updates directly to state so the UI paint picks them up in the same frame with no extra message-round-trip.
The downloads panel shows, per download:
- Filename and source URL
⬇ bytes downloaded / total size(e.g.⬇ 124.3 MB / 550.0 MB)- Live speed indicator (
1.5 MB/s) computed asΔbytes / elapsed_since_last_tick - Blacklight-purple progress bar (same colour as the window border trace)
- Action buttons: cancel (in-progress), open / reveal in Finder (completed), or clear (done)
Duplicate downloads
Re-clicking a link that is already being downloaded does not replace the existing entry. Each new click produces a new entry with a -2, -3, … suffix appended to the file stem (e.g. archive.zip, archive-2.zip, archive-3.zip). A 500 ms debounce window filters out WebKit's spurious double-fire of the download callback.
UI features
Tab system
- Floating squircle tabs with smooth pill-style activation glow
- Per-tab independent back / forward navigation history — switching tabs restores the correct page without re-requesting the server
- Two-finger horizontal swipe on macOS triggers browser back/forward natively via WebKit
- Tab groups with colour-coded indicators — create, rename, assign, delete groups; members can be cycled between groups with a right-click
- Opening a new tab always loads the built-in homepage
Address bar and URL resolution
The address bar (and all programmatic navigate calls) apply the same resolution logic:
| Input | Result |
|---|---|
https://example.com or http://… or file://… |
Used verbatim |
rust-lang.org (contains ., no spaces) |
Prepended with https:// |
cargo build flags (anything else) |
Google search: https://www.google.com/search?q=cargo+build+flags |
Loading indicator
A thin perimeter-tracing line (the "border trace" / loader) animates around the window edge while a page is loading. The line is the same blacklight purple as the progress bar. Once the page finishes loading, the line fades out smoothly.
Theme system
Three modes selectable per-session (not persisted across restarts yet):
| Mode | Behaviour |
|---|---|
ThemeMode::Light |
Always light palette |
ThemeMode::Dark |
Always dark palette |
ThemeMode::Auto |
Light from 07:00–19:00 local time; dark otherwise |
The theme is pushed into the embedded homepage via JavaScript (window.__tkzSetTheme) so the built-in page always matches the shell.
Persistent history
Every page visit is appended to ~/toolkit-zero/history.hist (toggle-able in the UI). The history panel supports:
- Time-based deletion with a slider +
Hours / Days / Weeks / Monthsunit picker - Delete all history in one click
- Click any entry to navigate
Quicklinks
The built-in homepage displays a grid of configurable quicklinks loaded from ~/toolkit-zero/quicklinks.json. Inject/update your quicklinks programmatically or edit the JSON directly.
macOS Dock icon
On macOS, the Dock tile icon is set at runtime via NSApplication::setApplicationIconImage: using objc2. Winit's window::Settings::icon is a no-op on macOS (per-window icons are not a platform concept), so duct-tape calls the AppKit API directly after the window is fully initialised.
CLI launch options
The duct-tape binary accepts optional arguments:
# Open the built-in homepage (default)
# Open a URL — back button returns to the homepage
# Address-bar resolution: adds https:// if no scheme; falls back to Google search
# Explicit Google search
# Open a local HTML file
All flags perform safety checks — an empty value prints a usage message and exits with code 1.
Rust API — launch functions
| Function | Description |
|---|---|
browser::launch_default() |
Open the built-in homepage; blocks until window closes |
browser::launch(target) |
Open with an explicit Target; blocks |
browser::launch_with_api(target, receiver) |
Launch + connect an ApiReceiver for programmatic control; blocks |
browser::launch_with_controller(target, closure) |
All-in-one — pass an async closure that receives the handle; spawns it and blocks internally |
All entry points block the calling thread (iced's event loop must run on the main thread). When called inside a tokio::task::block_in_place closure the async executor keeps running on other threads.
Target variants
| Variant | Behaviour |
|---|---|
Target::Default |
Opens the built-in homepage |
Target::Url(String) |
Navigates to an http:// / https:// URL |
Target::File(PathBuf) |
Loads a local file via file://; relative CSS/JS refs resolved automatically |
Target::Html(String) |
Injects a raw HTML string directly into the WebView — no file needed |
Target::UrlFromHome(String) |
Loads the homepage first (seeds the webview back-stack), then navigates to the URL — pressing Back returns to the homepage |
Programmatic control — launch_with_controller (recommended)
The cleanest way to drive the browser programmatically. Pass an async closure; duct-tape creates the channel pair, spawns your closure as a tokio task, and starts the window — all in a single call.
use ;
async
How launch_with_controller works internally
- Creates a
(BrowserHandle, ApiReceiver)pair. - Installs the receiver into the browser's process-global command queue.
- Calls
tokio::runtime::Handle::current().spawn(controller(handle))— your closure starts running on the tokio runtime's worker threads. - Calls
tokio::task::block_in_place(|| launch(target))— blocks the calling thread for the event loop while keeping the tokio executor alive for your spawned task.
Programmatic control — launch_with_api (explicit)
For cases where you need to manage the channel pair yourself — e.g. storing the handle in shared state, passing it to multiple tasks with different lifetimes, or integrating with an existing tokio setup.
use ;
async
BrowserHandle API reference
All methods are fire-and-forget — they enqueue a command and return immediately. The browser processes the queue on the next Tick (≤ 16 ms). BrowserHandle is Clone + Send; clone it freely across threads and tasks.
| Method | Description |
|---|---|
handle.navigate(tab: TabTarget, url: impl Into<String>) |
Navigate tab to url (same resolution as the address bar) |
handle.open_new_tab(url: Option<impl Into<String>>) |
None → new tab at homepage; Some(url) → new tab at URL |
handle.start_download(url: impl Into<String>) |
Trigger a parallel download of url; file lands in ~/Downloads/ |
handle.set_theme(mode: ThemeMode) |
Switch the colour theme immediately |
TabTarget
| Variant | Behaviour |
|---|---|
TabTarget::Active |
The currently visible tab |
TabTarget::New |
Always opens a brand-new tab |
TabTarget::Index(usize) |
Existing tab by 0-based index; creates a new tab if the index is out of range |
ThemeMode
| Variant | Behaviour |
|---|---|
ThemeMode::Light |
Always light palette |
ThemeMode::Dark |
Always dark palette |
ThemeMode::Auto |
Light 07:00–19:00 local time, dark otherwise |
License
MIT — see LICENSE.