Skip to main content

Module http

Module http 

Source
Expand description

Zero-axum public HTTP types.

User code says arcly_http::Response, arcly_http::Json, etc. — no axum::… paths in the public surface. Internally these are thin delegations to axum, so we keep its battle-tested implementation without welding it into the public API.

Why a private axum::response::Response re-export rather than a full newtype: pinning axum::response::Response is the one type the framework’s boundary code constructs; making it a newtype would force every adapter / interceptor to unwrap repeatedly with zero behavioural benefit. A pub use rename achieves the same “no axum in user paths” outcome at zero runtime cost.

Modules§

header
Standard header-name constants: header::CONTENT_TYPE, header::LOCATION, header::CONTENT_RANGE, header::CACHE_CONTROL, header::ACCEPT_RANGES, the header::ACCESS_CONTROL_* family, and the rest of the IANA registry.

Structs§

Body
Response/request body. Body::from(bytes), Body::from("text"), etc. The body type used in axum requests and responses.
Bytes
Raw bytes buffer (bytes::Bytes) — what RequestContext::body returns and what byte-oriented responses carry.
HeaderMap
Owned, validated header name / value, and the multimap that holds them. A specialized multimap for header names and values.
HeaderName
Owned, validated header name / value, and the multimap that holds them. Represents an HTTP header field name
HeaderValue
Owned, validated header name / value, and the multimap that holds them. Represents an HTTP header field value.
Json
JSON response wrapper. Json(body) writes Content-Type: application/json and serialises body with serde_json. Same surface as axum’s Json so the route macro’s return-type walker (Json<T> | Result<Json<T>, _>) keeps working without changes.
Method
HTTP method (Method::GET, …). The Request Method (VERB)
RequestParts
Decomposed request head (method, uri, headers, …). Named in the BoundaryFilter trait, so it must be reachable without axum.
ResponseBuilder
The builder returned by Response::builder — re-exported so it can be named in user function signatures (e.g. a with_cors(b: ResponseBuilder) helper) without reaching for axum. An HTTP response builder
StatusCode
HTTP status code (StatusCode::OK, StatusCode::PARTIAL_CONTENT, …). An HTTP status code (status-code in RFC 9110 et al.).
Uri
Request URI. The URI component of a request.

Traits§

IntoResponse
Convert a value into a Response.

Functions§

byte_range
Serve a (possibly partial) byte range from a fully-buffered resource.
bytes_response
Build a Response from a status, content type, and raw bytes.
to_bytes
Buffer a Body into Bytes up to a cap. Re-exported so subsystem modules can read response bodies (PII masking, etc.) without naming axum. Converts Body into Bytes and limits the maximum size of the body.

Type Aliases§

Response
The framework’s response type. Same memory shape as axum’s; the alias keeps the user-visible path arcly_http::Response. Type alias for http::Response whose body type defaults to Body, the most common body type used with axum.