tako-rs 2.5.0

Multi-transport Rust web framework: HTTP/1.1, HTTP/2, HTTP/3, WebTransport, WebSocket, SSE, gRPC, TCP, UDP and Unix sockets behind one router.
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

#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc = include_str!("lib.md")]

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::head;
pub use tako_rs_macros::options;
pub use tako_rs_macros::patch;
pub use tako_rs_macros::post;
pub use tako_rs_macros::put;
pub use tako_rs_macros::route;

/// Used only by macro-generated code; not part of the stable API.
#[doc(hidden)]
pub mod __private {
  pub use linkme;
}

pub use tako_rs_core::body;
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(any(feature = "tls", feature = "http3", feature = "compio-tls"))]
#[cfg_attr(
  docsrs,
  doc(cfg(any(feature = "tls", feature = "http3", feature = "compio-tls")))
)]
pub use tako_rs_core::tls;
#[cfg(feature = "tako-tracing")]
#[cfg_attr(docsrs, doc(cfg(feature = "tako-tracing")))]
pub use tako_rs_core::tracing;
pub use tako_rs_core::types;
#[cfg(feature = "ws")]
#[cfg_attr(docsrs, doc(cfg(feature = "ws")))]
pub use tako_rs_core::ws;
pub use tako_rs_server::AcceptBackoff;
#[cfg(any(feature = "tls", feature = "http3", feature = "compio-tls"))]
pub use tako_rs_server::ClientAuth;
#[cfg(feature = "compio")]
pub use tako_rs_server::CompioServer;
#[cfg(feature = "compio")]
pub use tako_rs_server::CompioServerBuilder;
pub use tako_rs_server::H3Congestion;
#[cfg(any(feature = "tls", feature = "http3", feature = "compio-tls"))]
pub use tako_rs_server::ReloadableResolver;
#[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::ServerError;
pub use tako_rs_server::ServerHandle;
pub use tako_rs_server::TlsCert;
pub use tako_rs_server::bind_with_port_fallback;
#[cfg(any(feature = "tls", feature = "http3", feature = "compio-tls"))]
pub use tako_rs_server::build_rustls_server_config;
#[cfg(feature = "proxy-protocol")]
pub use tako_rs_server::proxy_protocol;
#[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"), 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;
#[cfg(feature = "udp")]
pub use tako_rs_server::server_udp;
#[cfg(unix)]
pub use tako_rs_server::server_unix;
pub use tako_rs_server::shutdown_signal;
#[cfg(feature = "socket-activation")]
pub use tako_rs_server::socket_activation;
#[cfg(feature = "file-stream")]
#[cfg_attr(docsrs, doc(cfg(feature = "file-stream")))]
pub use tako_rs_streams::file_stream;
#[cfg(feature = "sse")]
pub use tako_rs_streams::sse;
pub use tako_rs_streams::r#static;

/// W3C WebTransport sessions on the HTTP/3 server, on either runtime; on Tokio also
/// `RawQuicSession`, a plain QUIC endpoint for peers that do not speak WebTransport.
#[cfg(feature = "webtransport")]
#[cfg_attr(docsrs, doc(cfg(feature = "webtransport")))]
pub mod webtransport {
  pub use tako_rs_server::webtransport::*;
  #[cfg(not(feature = "compio"))]
  pub use tako_rs_streams::webtransport::*;
}

/// Request data extraction utilities.
pub mod extractors {
  pub use tako_rs_core::extractors::Entries;
  pub use tako_rs_core::extractors::FromRequest;
  pub use tako_rs_core::extractors::FromRequestParts;
  pub use tako_rs_core::extractors::body;
  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;
  /// JWT parsing and extraction of claims verified by `JwtAuth` middleware.
  pub mod jwt {
    pub use tako_rs_extractors::jwt::*;
    pub use tako_rs_plugins::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(any(feature = "simd-sonic", feature = "simd-json-impl"))]
  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;
}

#[cfg(feature = "zero-copy-extractors")]
#[cfg_attr(docsrs, doc(cfg(feature = "zero-copy-extractors")))]
pub use tako_rs_extractors::zero_copy_extractors;

/// 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::alt_svc;
  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;
  #[cfg(not(any(feature = "compio", feature = "compio-tls")))]
  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 = "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::PerThreadShutdown;
#[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")]
#[cfg_attr(docsrs, doc(cfg(feature = "per-thread")))]
pub use tako_rs_server_pt::spawn_per_thread;
#[cfg(feature = "jemalloc")]
#[cfg_attr(docsrs, doc(cfg(feature = "jemalloc")))]
pub use tikv_jemallocator::Jemalloc;

/// The types most handlers need, for `use tako::prelude::*;`. Modules stay at their
/// canonical paths, such as `tako::extractors` and `tako::middleware`.
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;
}