tideway 0.7.17

A batteries-included Rust web framework built on Axum for building SaaS applications quickly
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

# Module Contracts

Tideway is batteries-included, but module composition is explicit and stable.

## Contract Surface

The primary contract surface for app composition is:

- `App::register_module(module)`
- `App::register_optional_module(module)`
- `App::register_modules(iter)` for homogeneous module lists
- `tideway::register_modules!` for mixed module types
- `tideway::register_optional_modules!` for optional-only composition
- `tideway::prelude::*` for curated common imports

These APIs are intended to remain stable and are covered by tests.

## Prelude Contract

`tideway::prelude::*` is intentionally curated and small:

- Core app/config types (`App`, `AppBuilder`, `ConfigBuilder`, `AppContext`, `Result`, etc.)
- Module composition macros (`module!`, `register_modules!`, `register_optional_modules!`)
- Feature-specific exports only when their feature is enabled

Use the prelude for application code when you want stable, low-friction imports.

## Feature-Gated Modules

Feature-gated modules are explicit (`auth`, `database`, `openapi`, etc.).

Two enforcement modes exist:

- `feature-gate-errors`: compile-time errors with actionable guidance
- `feature-gate-warnings`: deprecated module stubs that compile, with warnings

Example:

```toml
[dependencies]
tideway = { version = "0.7.17", default-features = false, features = ["feature-gate-errors"] }
```

In this mode, using disabled modules yields clear messages such as:
"Enable the `auth` feature to use tideway::auth".

## Stability Guidance

When evolving module APIs:

1. Prefer additive changes over path/shape breaks.
2. Keep generated scaffolds aligned with this contract surface.
3. Update prelude exports intentionally and guard with tests.
4. Keep feature-gate error messages actionable and specific.