Crate tork_core 

Core runtime for the Tork web framework.

This crate holds everything that runs at request time: the HTTP server built on Hyper and Tokio, the router, the dependency-injection traits, response and error types. It contains no procedural macros; those live in tork-macros.

End users do not depend on this crate directly. They depend on the tork facade crate, which re-exports the public surface defined here.

Re-exports

pub use middleware::DuplicatePolicy;

pub use middleware::Middleware;

pub use middleware::Next;

pub use middleware::Request;

pub use security::constant_time_eq;

pub use mime;

Modules

constants

Named constants used across the runtime.

header

HTTP header types

middleware

The middleware layer.

security

Small security helpers for application code.

testing

In-process test harness.

Macros

assert_logs

Asserts a recorder captured a log with the given context and message substring.

Structs

App

The application builder.

AppInner

The finalized application: shared state plus a compiled route matcher.

BearerToken

A bearer token extracted from the Authorization header.

ByIp

The default key strategy: the client IP address.

Cache

A cheap-to-clone handle over a CacheStore, with a typed, ergonomic API.

Error

A framework error that can be turned into an HTTP error response.

ErrorContext

Context passed to an exception_handler alongside the recovered typed error.

ErrorDetail

A single field-level error, included in validation responses.

ErrorEvent

Context for on_error: a non-validation error was produced.

FileBytes

A buffered uploaded file, held entirely in memory.

FileLogConfig

Configuration for a rolling file log sink.

Form

An application/x-www-form-urlencoded request body, deserialized and validated.

HeaderMap

A specialized multimap for header names and values.

HeaderName

Represents an HTTP header field name

HeaderValue

Represents an HTTP header field value.

Http1Config

HTTP/1 connection tuning applied to every served connection.

Http2Config

HTTP/2 connection tuning applied to every served connection.

Hub

A registry of broadcast Rooms keyed by name.

Json

A JSON response wrapper.

LastEventId

The Last-Event-ID header sent by a client resuming an SSE stream.

LifespanContext

Context passed to a lifespan’s startup.

LogEvent

A log record being built. Add fields and an error, then emit.

LogSpan

A span being built. Add fields, then enter a scope or run a future inside it.

Logger

A context-aware logger.

LoggerConfig

How the application logs.

Matcher

Compiled, per-method path matcher over a flat route table.

MemoryStore

An in-memory CacheStore with per-entry TTL, backed by moka.

MemoryThrottleStore

An in-memory ThrottleStore backed by a map of counters.

Method

The Request Method (VERB)

Multipart

A multipart/form-data request body bound to a form model.

PanicEvent

Context for on_panic: a handler panicked and the panic was caught by the panic boundary.

PathParams

Raw path parameters captured by the router, in match order.

ReadyContext

Context passed to on_ready hooks, after the listener has bound.

RequestContext

Everything an extractor needs to resolve a value from the current request.

RequestEvent

Context for on_request: a request has arrived.

RespBody

The outbound response body.

ResponseEvent

Context for on_response: a response is ready.

Room

A single broadcast room: send to all subscribers, or subscribe to receive.

Route

A single route: an HTTP method, a path pattern, a handler, and metadata.

RouteMeta

Introspection metadata for a route, used to build the OpenAPI document.

Router

A group of routes sharing a path prefix and a set of tags.

SecretString

A string whose value is kept out of logs and debug output.

SettingsLoader

Loads and validates a typed configuration from layered sources.

Sse

A streaming text/event-stream response carrying events of data type T.

SseEvent

A single Server-Sent Event with optional metadata.

SseResume

The Last-Event-ID header parsed into a typed resume cursor.

State

Extractor that yields a clone of an application state value of type S.

StateMap

A type-erased, thread-safe container for application state values.

StatusCode

An HTTP status code (status-code in RFC 9110 et al.).

TelemetryConfig

Configuration for OpenTelemetry trace export (effective with the otel feature).

TestApp

An application built for in-process testing.

Throttle

Configures rate limiting; see App::throttle.

Throttler

The runtime throttle engine, injectable and used by generated route code.

TorkService

A Hyper Service that hands each request to the application.

UploadConfig

Limits and temp-file behavior for multipart uploads.

UploadFile

An uploaded file backed by a spooled temporary file.

Valid

Deserializes the JSON request body into T and validates it.

ValidationErrorEvent

Context for on_validation_error: a request body failed validation (422).

WebSocket

A WebSocket upgrade handle: call accept to open it.

WebSocketConfig

Limits and timeouts for a WebSocket connection.

WebSocketConn

A live WebSocket connection.

WsClose

A close control frame: a status code and a human-readable reason.

WsConnectInfo

Context for on_ws_connect: a socket opened.

WsDisconnectInfo

Context for on_ws_disconnect: a socket closed.

WsError

An error raised while handling a WebSocket connection.

WsReceiver

Receiving-half of the broadcast channel.

Enums

ErrorKind

The category of an Error, which determines the HTTP status code.

ErrorLogDetail

How much structured error detail a logged record includes.

IpNet

An IP network address, either IPv4 or IPv6.

LogFormat

The console output format.

Match

The outcome of matching a request against the route table.

RequestBodyKind

The encoding of a route’s request body, for OpenAPI documentation.

Rotation

How often a file log is rolled over.

ThrottlePolicy

The rate-limit policy attached to a route, emitted by the throttle attribute.

WsCloseCode

A WebSocket close status code.

WsMessage

A WebSocket message.

Traits

AsyncApiProvider

Produces the routes that serve the AsyncAPI document.

CacheStore

A cache backend that stores opaque byte values under string keys.

FromMultipart

Builds a value from a parsed multipart body.

FromPathParam

Parses a single captured URL segment into a typed path parameter.

FromRequest

Produces a value from the current request to satisfy a handler parameter.

IntoResponse

Converts a value into an HTTP Response.

Lifespan

The startup and shutdown lifecycle of a resource container.

OpenApiProvider

Produces the routes that serve the OpenAPI document and documentation UI.

Resources

A type that contributes resources to the application registry.

ThrottleKey

Produces the key a request is rate-limited by (the “tracker”).

ThrottleStore

A backend that counts requests per key within a time window.

Functions

box_body

Erases any compatible HTTP body into the runtime’s ReqBody type.

bytes_response

Builds a response from a pre-serialized body and an explicit content type.

json_response

Serializes value to JSON and builds a response with the given status.

Type Aliases

AppStateRef

A shared, reference-counted handle to the application state map.

BoxError

Boxed, thread-safe error type carried by an erased request body.

BoxFuture

A boxed, sendable future of a request handler’s response.

HandlerFn

A type-erased request handler.

ReqBody

The inbound request body type.

Response

The concrete HTTP response type used throughout the framework.

Result

A specialized Result whose error type defaults to Error.

SchemaThunk

Produces a JSON Schema for a type, recorded as a function pointer so that RouteMeta stays Copy-free of any concrete type while still describing request and response bodies.