Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Generated module

FileContents
mod.rsThe root of the module. It declares the other files and re-exports the client, the server and the runtime.
types.rsThe schemas of the description as Rust types: structs, enums and newtypes.
operations.rsOne module per operation with its Params, its Response enum and their body types.
client.rsThe Client with one method per operation, and the WebhookClient when the description has webhooks.
server.rsThe Api trait with one method per operation, the router and the Server of this API.
runtime.rsThe runtime items that the generated code calls, re-exported from honig.
documented_examples.rsWith tests = true: a test that decodes each example of the description into its type.

Every file starts with // @generated. Do not edit it. Change the description and run cargo honig generate. The files of the module are declared #[rustfmt::skip]. Your cargo fmt --check leaves them as generated.