ntex 4.0.0

Framework for composable network services
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

<div>
  <h1>ntex</h1>
  <p><strong>Framework for composable network services.</strong></p>

[![Linux](https://github.com/ntex-rs/ntex/actions/workflows/linux.yml/badge.svg?branch=main)](https://github.com/ntex-rs/ntex/actions/workflows/linux.yml)
[![crates.io](https://img.shields.io/crates/v/ntex.svg)](https://crates.io/crates/ntex)
[![Documentation](https://img.shields.io/docsrs/ntex/latest)](https://docs.rs/ntex)
[![MSRV](https://img.shields.io/badge/rustc-1.97+-lightgray.svg)](https://releases.rs/docs/1.97.0/)
[![License](https://img.shields.io/crates/l/ntex.svg)](https://github.com/ntex-rs/ntex#license)
[![codecov](https://codecov.io/gh/ntex-rs/ntex/branch/main/graph/badge.svg)](https://codecov.io/gh/ntex-rs/ntex/tree/main)
[![Discord](https://img.shields.io/discord/919288597826387979?label=chat&logo=discord)](https://discord.gg/4GtaeP5Uqu)
</div>

ntex provides a strongly typed component for building
asynchronous network applications. It includes HTTP/1, HTTP/2, WebSocket,
TLS, and runtime-independent I/O support. MQTT, AMQP, and gRPC are provided
by [related projects](#related-projects).

## Build status

| Platform | Status |
| --- | --- |
| Linux | [![Linux](https://github.com/ntex-rs/ntex/actions/workflows/linux.yml/badge.svg?branch=main)](https://github.com/ntex-rs/ntex/actions/workflows/linux.yml) |
| macOS | [![macOS](https://github.com/ntex-rs/ntex/actions/workflows/osx.yml/badge.svg?branch=main)](https://github.com/ntex-rs/ntex/actions/workflows/osx.yml) |
| Windows | [![Windows](https://github.com/ntex-rs/ntex/actions/workflows/windows.yml/badge.svg?branch=main)](https://github.com/ntex-rs/ntex/actions/workflows/windows.yml) |

## Usage

Add ntex to your project:

```toml
[dependencies]
ntex = "4"
```

A minimal web server looks like this:

```rust
use ntex::{SharedCfg, web};

#[web::get("/")]
async fn index() -> &'static str {
    "Hello world!"
}

#[ntex::main]
async fn main() -> std::io::Result<()> {
    web::HttpServer::new(async |_| web::App::new().service(index))
        .bind("127.0.0.1:8080", SharedCfg::new("hello-world"))?
        .run()
        .await
}
```

## Runtime selection

Without an explicit runtime feature, ntex uses its native single-threaded
runtime and automatically selects a platform I/O reactor:

- Linux tries `io_uring` and falls back to polling.
- Other Unix platforms use polling.
- Windows uses IOCP.

Alternative runtimes and native reactors can be selected with Cargo features:

| Feature | Runtime or reactor |
| --- | --- |
| `tokio` | Tokio local runtime and I/O driver |
| `compio` | Compio runtime and completion-based I/O |
| `neon-polling` | Native runtime with the polling reactor on Unix |
| `neon-uring` | Native runtime with `io_uring` on Linux |

Enable at most one runtime or native-reactor selection feature. For example:

```toml
[dependencies]
ntex = { version = "4", features = ["tokio"] }
```

## Optional features

- `openssl` and `rustls` enable the corresponding TLS integrations.
- `compress` enables HTTP content compression.
- `cookie` enables cookie support.
- `ws` enables WebSocket APIs and is enabled by default.

## Related projects

| Project | Description |
| --- | --- |
| [ntex-mqtt](https://github.com/ntex-rs/ntex-mqtt) | Client and server framework for MQTT v5 and v3.1.1 |
| [ntex-amqp](https://github.com/ntex-rs/ntex-amqp) | Client and server framework for AMQP 1.0 |
| [ntex-grpc](https://github.com/ntex-rs/ntex-grpc) | Client and server framework for gRPC |

## Documentation and community

- [Framework guide](https://github.com/ntex-rs/ntex/tree/main/docs/index.md)
- [Web framework documentation](https://ntex.rs)
- [API documentation](https://docs.rs/ntex)
- [Examples](https://github.com/ntex-rs/examples)
- [Release changes](https://github.com/ntex-rs/ntex/blob/main/ntex/CHANGES.md)
- Minimum supported Rust version: 1.97

## License

This project is licensed under either of:

- Apache License, Version 2.0
  ([LICENSE-APACHE](https://github.com/ntex-rs/ntex/blob/main/LICENSE-APACHE) or
  <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license
  ([LICENSE-MIT](https://github.com/ntex-rs/ntex/blob/main/LICENSE-MIT) or
  <https://opensource.org/licenses/MIT>)