tako-rs 2.0.0

Multi-transport Rust framework for modern network services.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

#![cfg_attr(docsrs, feature(doc_cfg))]

//! A multi-transport Rust framework for modern network services.
//!
//! Tako is built for services that go beyond plain HTTP. It gives you one
//! cohesive model for routing, extraction, middleware, streaming, observability,
//! and graceful shutdown across several protocols and transport layers.
//!
//! This umbrella crate stitches together the workspace sub-crates:
//!
//! - `tako-core` — routing, handlers, middleware and plugin traits, body and
//!   request types, state, signals, queue, plus `GraphQL`, gRPC and `OpenAPI`
//!   helpers
//! - `tako-extractors` — concrete request extractors (cookies, form, query,
//!   path, JWT, multipart, simdjson, …)
//! - `tako-server` — HTTP/1, TLS, HTTP/3, raw TCP / UDP / Unix, PROXY protocol,
//!   plus the compio variants
//! - `tako-streams` — WebSocket, SSE, file streaming, static file serving,
//!   WebTransport
//! - `tako-plugins` — built-in middleware (auth, CSRF, sessions, …) and
//!   plugins (CORS, compression, rate limiting, idempotency, metrics)
//!
//! All public types stay reachable at the original `tako::*` paths.

pub use tako_rs_core::Bytes;
pub use tako_rs_core::Full;
pub use tako_rs_core::Method;
pub use tako_rs_core::NOT_FOUND;
pub use tako_rs_core::StatusCode;
pub use tako_rs_core::header;
pub use tako_rs_macros::delete;
pub use tako_rs_macros::get;
pub use tako_rs_macros::patch;
pub use tako_rs_macros::post;
pub use tako_rs_macros::put;
pub use tako_rs_macros::route;

/// Implementation details for tako's proc macros. Not part of the stable
/// API — relied on only by macro-generated code.
#[doc(hidden)]
pub mod __private {
  pub use linkme;
}

pub use tako_rs_core::body;
// `tako_rs_core::client` is tokio-runtime-only (tokio-rustls + hyper-util
// client-legacy). When `compio` is also enabled, the upstream crate refuses
// to compile the `client` module, so we cannot re-export it either. We
// surface this as a docs-only note rather than a `compile_error!`, because
// the workspace `cargo check --workspace --all-features` invocation turns
// every feature on simultaneously and we must not break that — when
// `compio` is on, `tako::client` is intentionally absent, see the cfg
// expression for the exact condition.
#[cfg(all(feature = "client", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(all(feature = "client", not(feature = "compio")))))]
pub use tako_rs_core::client;
pub use tako_rs_core::config;
pub use tako_rs_core::conn_info;
#[cfg(feature = "graphiql")]
#[cfg_attr(docsrs, doc(cfg(feature = "graphiql")))]
pub use tako_rs_core::graphiql;
#[cfg(feature = "async-graphql")]
#[cfg_attr(docsrs, doc(cfg(feature = "async-graphql")))]
pub use tako_rs_core::graphql;
#[cfg(feature = "grpc")]
#[cfg_attr(docsrs, doc(cfg(feature = "grpc")))]
pub use tako_rs_core::grpc;
#[cfg(any(feature = "utoipa", feature = "vespera"))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "utoipa", feature = "vespera"))))]
pub use tako_rs_core::openapi;
pub use tako_rs_core::problem;
pub use tako_rs_core::queue;
pub use tako_rs_core::redirect;
pub use tako_rs_core::responder;
pub use tako_rs_core::route;
pub use tako_rs_core::router;
pub use tako_rs_core::router_state;
#[cfg(feature = "signals")]
#[cfg_attr(docsrs, doc(cfg(feature = "signals")))]
pub use tako_rs_core::signals;
pub use tako_rs_core::state;
#[cfg(feature = "tako-tracing")]
#[cfg_attr(docsrs, doc(cfg(feature = "tako-tracing")))]
pub use tako_rs_core::tracing;
pub use tako_rs_core::types;
pub use tako_rs_server::AcceptBackoff;
#[cfg(feature = "compio")]
pub use tako_rs_server::CompioServer;
#[cfg(feature = "compio")]
pub use tako_rs_server::CompioServerBuilder;
#[cfg(not(feature = "compio"))]
pub use tako_rs_server::Server;
#[cfg(not(feature = "compio"))]
pub use tako_rs_server::ServerBuilder;
pub use tako_rs_server::ServerConfig;
pub use tako_rs_server::ServerHandle;
pub use tako_rs_server::TlsCert;
pub use tako_rs_server::bind_with_port_fallback;
#[cfg(not(any(feature = "compio", feature = "compio-tls", feature = "compio-ws")))]
pub use tako_rs_server::proxy_protocol;
pub use tako_rs_server::serve;
#[cfg(all(feature = "http2", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http2")))]
pub use tako_rs_server::serve_h2c;
#[cfg(all(feature = "http2", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http2")))]
pub use tako_rs_server::serve_h2c_with_config;
#[cfg(all(feature = "http2", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http2")))]
pub use tako_rs_server::serve_h2c_with_shutdown;
#[cfg(all(feature = "http2", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http2")))]
pub use tako_rs_server::serve_h2c_with_shutdown_and_config;
#[cfg(all(feature = "http3", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http3")))]
pub use tako_rs_server::serve_h3;
#[cfg(all(feature = "http3", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http3")))]
pub use tako_rs_server::serve_h3_with_config;
#[cfg(all(feature = "http3", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http3")))]
pub use tako_rs_server::serve_h3_with_shutdown;
#[cfg(all(feature = "http3", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http3")))]
pub use tako_rs_server::serve_h3_with_shutdown_and_config;
#[cfg(any(
  all(
    feature = "tls",
    not(any(feature = "compio", feature = "compio-tls", feature = "compio-ws"))
  ),
  feature = "compio-tls"
))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "tls", feature = "compio-tls"))))]
pub use tako_rs_server::serve_tls;
#[cfg(all(
  feature = "tls",
  not(any(feature = "compio", feature = "compio-tls", feature = "compio-ws"))
))]
#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
pub use tako_rs_server::serve_tls_with_config;
#[cfg(any(
  all(
    feature = "tls",
    not(any(feature = "compio", feature = "compio-tls", feature = "compio-ws"))
  ),
  feature = "compio-tls"
))]
#[cfg_attr(docsrs, doc(cfg(any(feature = "tls", feature = "compio-tls"))))]
pub use tako_rs_server::serve_tls_with_shutdown;
#[cfg(all(
  feature = "tls",
  not(any(feature = "compio", feature = "compio-tls", feature = "compio-ws"))
))]
#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
pub use tako_rs_server::serve_tls_with_shutdown_and_config;
#[cfg(not(feature = "compio"))]
pub use tako_rs_server::serve_with_config;
pub use tako_rs_server::serve_with_shutdown;
#[cfg(not(feature = "compio"))]
pub use tako_rs_server::serve_with_shutdown_and_config;
#[cfg(feature = "compio")]
#[cfg_attr(docsrs, doc(cfg(feature = "compio")))]
pub use tako_rs_server::server_compio;
#[cfg(all(feature = "http2", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http2")))]
pub use tako_rs_server::server_h2c;
#[cfg(all(feature = "http3", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "http3")))]
pub use tako_rs_server::server_h3;
pub use tako_rs_server::server_tcp;
#[cfg(all(not(feature = "compio-tls"), feature = "tls"))]
#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
pub use tako_rs_server::server_tls;
#[cfg(feature = "compio-tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "compio-tls")))]
pub use tako_rs_server::server_tls_compio;
pub use tako_rs_server::server_udp;
#[cfg(all(
  unix,
  not(any(feature = "compio", feature = "compio-tls", feature = "compio-ws"))
))]
pub use tako_rs_server::server_unix;
#[cfg(feature = "file-stream")]
#[cfg_attr(docsrs, doc(cfg(feature = "file-stream")))]
pub use tako_rs_streams::file_stream;
pub use tako_rs_streams::sse;
pub use tako_rs_streams::r#static;
#[cfg(all(feature = "webtransport", not(feature = "compio")))]
#[cfg_attr(docsrs, doc(cfg(feature = "webtransport")))]
pub use tako_rs_streams::webtransport;
#[cfg(not(any(feature = "compio", feature = "compio-ws")))]
pub use tako_rs_streams::ws;
#[cfg(feature = "compio-ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "compio-ws")))]
pub use tako_rs_streams::ws_compio;

/// Request data extraction utilities.
pub mod extractors {
  pub use tako_rs_core::extractors::FromRequest;
  pub use tako_rs_core::extractors::FromRequestParts;
  #[doc(hidden)]
  pub use tako_rs_core::extractors::is_json_content_type;
  pub use tako_rs_core::extractors::json;
  pub use tako_rs_core::extractors::params;
  pub use tako_rs_core::extractors::range;
  pub use tako_rs_core::extractors::typed_params;
  pub use tako_rs_extractors::acc_lang;
  pub use tako_rs_extractors::accept;
  pub use tako_rs_extractors::basic;
  pub use tako_rs_extractors::bearer;
  pub use tako_rs_extractors::bytes;
  pub use tako_rs_extractors::connect_info;
  pub use tako_rs_extractors::content_length_limit;
  pub use tako_rs_extractors::cookie_jar;
  pub use tako_rs_extractors::cookie_key_expansion;
  pub use tako_rs_extractors::cookie_private;
  pub use tako_rs_extractors::cookie_signed;
  pub use tako_rs_extractors::extension;
  pub use tako_rs_extractors::form;
  pub use tako_rs_extractors::header_map;
  pub use tako_rs_extractors::ipaddr;
  pub use tako_rs_extractors::jwt;
  pub use tako_rs_extractors::matched_path;
  #[cfg(feature = "multipart")]
  #[cfg_attr(docsrs, doc(cfg(feature = "multipart")))]
  pub use tako_rs_extractors::multipart;
  pub use tako_rs_extractors::path;
  #[cfg(feature = "protobuf")]
  #[cfg_attr(docsrs, doc(cfg(feature = "protobuf")))]
  pub use tako_rs_extractors::protobuf;
  pub use tako_rs_extractors::query;
  pub use tako_rs_extractors::query_multi;
  #[cfg(feature = "simd")]
  #[cfg_attr(docsrs, doc(cfg(feature = "simd")))]
  pub use tako_rs_extractors::simdjson;
  pub use tako_rs_extractors::state;
  #[cfg(feature = "typed-header")]
  #[cfg_attr(docsrs, doc(cfg(feature = "typed-header")))]
  pub use tako_rs_extractors::typed_header;
  pub use tako_rs_extractors::uri_parts;
  #[cfg(any(feature = "validator", feature = "garde"))]
  #[cfg_attr(docsrs, doc(cfg(any(feature = "validator", feature = "garde"))))]
  pub use tako_rs_extractors::validate;
}

/// Middleware for processing requests and responses in a pipeline.
pub mod middleware {
  pub use tako_rs_core::middleware::IntoMiddleware;
  pub use tako_rs_core::middleware::Next;
  pub use tako_rs_plugins::middleware::access_log;
  pub use tako_rs_plugins::middleware::api_key_auth;
  pub use tako_rs_plugins::middleware::basic_auth;
  pub use tako_rs_plugins::middleware::bearer_auth;
  pub use tako_rs_plugins::middleware::body_limit;
  pub use tako_rs_plugins::middleware::circuit_breaker;
  pub use tako_rs_plugins::middleware::csrf;
  pub use tako_rs_plugins::middleware::etag;
  pub use tako_rs_plugins::middleware::healthcheck;
  #[cfg(feature = "hmac-signature")]
  #[cfg_attr(docsrs, doc(cfg(feature = "hmac-signature")))]
  pub use tako_rs_plugins::middleware::hmac_signature;
  #[cfg(feature = "ip-filter")]
  #[cfg_attr(docsrs, doc(cfg(feature = "ip-filter")))]
  pub use tako_rs_plugins::middleware::ip_filter;
  #[cfg(feature = "json-schema")]
  #[cfg_attr(docsrs, doc(cfg(feature = "json-schema")))]
  pub use tako_rs_plugins::middleware::json_schema;
  pub use tako_rs_plugins::middleware::jwt_auth;
  pub use tako_rs_plugins::middleware::problem_json;
  pub use tako_rs_plugins::middleware::request_id;
  pub use tako_rs_plugins::middleware::security_headers;
  pub use tako_rs_plugins::middleware::session;
  pub use tako_rs_plugins::middleware::tenant;
  pub use tako_rs_plugins::middleware::timeout;
  pub use tako_rs_plugins::middleware::traceparent;
  pub use tako_rs_plugins::middleware::upload_progress;
}

/// Pluggable backend traits for stateful middleware (sessions, rate limiting, …).
pub mod stores {
  pub use tako_rs_plugins::stores::*;
}

#[cfg(feature = "plugins")]
#[cfg_attr(docsrs, doc(cfg(feature = "plugins")))]
pub mod plugins {
  pub use tako_rs_core::plugins::TakoPlugin;
  pub use tako_rs_plugins::plugins::compression;
  pub use tako_rs_plugins::plugins::cors;
  pub use tako_rs_plugins::plugins::idempotency;
  #[cfg(any(feature = "metrics-prometheus", feature = "metrics-opentelemetry"))]
  #[cfg_attr(
    docsrs,
    doc(cfg(any(feature = "metrics-prometheus", feature = "metrics-opentelemetry")))
  )]
  pub use tako_rs_plugins::plugins::metrics;
  pub use tako_rs_plugins::plugins::rate_limiter;
}

#[cfg(feature = "zero-copy-extractors")]
#[cfg_attr(docsrs, doc(cfg(feature = "zero-copy-extractors")))]
pub use tako_rs_extractors::zero_copy_extractors;
#[cfg(feature = "per-thread")]
#[cfg_attr(docsrs, doc(cfg(feature = "per-thread")))]
pub use tako_rs_server_pt::PerThreadConfig;
#[cfg(feature = "per-thread")]
#[cfg_attr(docsrs, doc(cfg(feature = "per-thread")))]
pub use tako_rs_server_pt::serve_per_thread;
#[cfg(feature = "per-thread-compio")]
#[cfg_attr(docsrs, doc(cfg(feature = "per-thread-compio")))]
pub use tako_rs_server_pt::serve_per_thread_compio;

#[cfg(feature = "jemalloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "jemalloc")))]
#[global_allocator]
static GLOBAL: tikv_jemallocator::Jemalloc = tikv_jemallocator::Jemalloc;

/// Re-exports of the types most handlers reach for in everyday code.
///
/// Import everything with `use tako::prelude::*;` to get `Method`,
/// `StatusCode`, `Router`, `Responder`, `Request`, `Response`, the common
/// body / query / form / path extractors, and the middleware traits.
/// The prelude intentionally re-exports types only — modules stay at their
/// canonical `tako::extractors::…` / `tako::middleware::…` paths so users
/// can still pull individual items in qualified form when they prefer.
pub mod prelude {
  pub use tako_rs_core::Method;
  pub use tako_rs_core::StatusCode;
  pub use tako_rs_core::body::TakoBody;
  pub use tako_rs_core::extractors::FromRequest;
  pub use tako_rs_core::extractors::FromRequestParts;
  pub use tako_rs_core::extractors::json::Json;
  pub use tako_rs_core::extractors::params::Params;
  pub use tako_rs_core::middleware::IntoMiddleware;
  pub use tako_rs_core::middleware::Next;
  pub use tako_rs_core::responder::Responder;
  pub use tako_rs_core::router::Router;
  pub use tako_rs_core::types::Request;
  pub use tako_rs_core::types::Response;
  pub use tako_rs_extractors::form::Form;
  pub use tako_rs_extractors::path::Path;
  pub use tako_rs_extractors::query::Query;
  pub use tako_rs_extractors::state::State;
}