Expand description
A simple and fast web server framework.
Re-exports§
pub use static_files::StaticDir;pub use websocket::WebSocket;pub use websocket::WebSocketReceiver;pub use websocket::WebSocketSender;pub use websocket::WebSocketUpgrade;
Modules§
- extract
- Extract strong-typed object from your request.
- handler
- Handle the request and make a response.
- header
- HTTP header types
- middleware
- Utility for writing middleware.
- openapi
- OpenAPI helpers.
OpenAPI helpers powered by
utoipaschemas. - responder
- Modify response or make a response,but in a strong-typed way.
- routing
- Tree-based routing primitives.
- runtime
- Runtime primitives leveraged by
#[skyzen::main]. Runtime utilities used by#[skyzen::main]. - static_
files - Static asset helpers for building file servers.
- utils
- Utilities.
- websocket
- WebSocket support for both native and WASM targets.
Structs§
- Body
- Flexible HTTP body that can represent data in various forms.
- Error
- A concrete error type for HTTP operations.
- Ignore
Open Api - Wrapper that explicitly opts out of
OpenAPIschema generation for contained extractors or responders. - Method
- The Request Method (VERB)
- OpenApi
- Minimal
OpenAPIrepresentation for Skyzen routers. - Open
ApiOperation - Description of a single handler operation.
- Route
- Collection of route nodes anchored at a path prefix.
- Status
Code - An HTTP status code (
status-codein RFC 9110 et al.). - Uri
- The URI component of a request.
Enums§
- Body
Error - Error type for body operations.
- WebSocket
Message - Message transmitted over a websocket connection.
Traits§
- Create
Route Node - Builder extension that turns a path literal into convenient routing nodes.
- Endpoint
- A trait for types that can handle HTTP requests and generate responses.
- Http
Error - Trait for errors that have an associated HTTP status code.
- Middleware
- Trait for implementing middleware that can process HTTP requests and responses.
- Partial
Schema - Trait used to implement only
Schemapart of the OpenAPI doc. - Responder
- Transform a object into a part of HTTP response,always is response body,header,etc.
- Result
Ext - Extension trait for
ResultandOptionto set HTTP status code on error. - Server
- Abstraction over HTTP server backends.
- ToSchema
- Trait for implementing OpenAPI Schema object.
Type Aliases§
- BoxHttp
Error - A boxed HTTP error trait object.
- Request
- A type alias for HTTP requests with a custom
Bodytype. - Response
- A type alias for HTTP responses with a custom
Bodytype. - Result
- Result type used in skyzen.
Attribute Macros§
- error
- Attribute & derive macros exported by Skyzen.
Error helper that implements
Display,Error, andHttpError. - main
- Attribute & derive macros exported by Skyzen. Attribute macro that boots a Skyzen Endpoint on native or wasm runtimes.
- openapi
- Attribute & derive macros exported by Skyzen.
Annotate handlers that should appear in generated
OpenAPIdocumentation.